华为3com需求设计写作培训.pdf

需求设计写作培训需求设计写作培训 质量管理部 SQA小组 2005.06 课程范围 仅关注如何写作文档 不涉及具体的需求分析和设计方法不涉及具体的需求分析和设计方法 课程内容 为什么要文档化 文档写作基本要求 需求设计文档模板 需求文档写作 设计文档写作 为什么要文档化 开发人员通过文档化的过程查错补遗； 便于评审，在早期发现技术上的问题； 可 读 后续阶段开发任务可能由他人承担，输 性 出文档便于他们开展工作出文档便于他们开展工作；； 就就 维护人员开展维护工作需要； 尤 为 文档是必要的交付件； 关 ………… 键 为什么要文档化 “所有的过程分析都要形成文档。我们现在有一个严重的问题是，大 家好像不喜欢写文档，对于需要的实现方案，通常都是一个负责人在脑 袋里想想该怎么实现，然后邮件或电话找几个相关人员讨论一下就算可 以了，可能连个会议材料或会议纪要都没有。 而老外可不是这样的，他们非常非常重视文档，他们认为一个人在 脑袋里想的东西是不清晰也不全面的脑袋里想的东西是不清晰也不全面的，，有时候心里想的认为很正确的方有时候心里想的认为很正确的方 案实际上可能存在致命缺陷。他们要求必须把心里的想法形成文档才能 有效的避免这种问题。写文档的过程中，可以更加有效的、更进一步去 整理您原来心里的思路，很多问题在您写过文档的过程中您就能发现； 另外，文档写作多使用图表，浪费口水的文字尽量少用，和我们一起工 作的系统工程师在系统架构分析中就画了五六十张图，就算看不懂他写 的英文，从图中我们就能够很清晰的指导整个产品的系统架构。” —— 摘自一位华为员工的瑞典出差报告 出差报告 5 课程内容 为什么要文档化 文档写作基本要求 需求设计文档模板 需求文档写作 设计文档写作 文档写作基本要求 下面的文档出自于我们开发人员的手笔，大家 觉得如何？ 特性1需求 特性2需求 特性3需求设计 特性4需求设计 文档写作基本要求  应使用标准模板写作；  文档封页、页眉页脚、修订记录、附录、参考文 献应完善；  关键词、摘要、缩略语应完整；  目录要及时更新；  通篇文档标题、文字格式、间距应协调美观；  所有文档模板中的章节，只可增加，不可删除；