华为需求与设计工程文档写作(含模版).ppt

发布时间：2022-05-30 发布人：admin 分类：说明书资料大小：4.30M 资料格式：ppt 举报版权申诉

junwr2012-11751638-4744302543308849368.ppt.pdf-第1页.png

第1页 / 共90页

junwr2012-11751638-4744302543308849368.ppt.pdf-第2页.png

第2页 / 共90页

junwr2012-11751638-4744302543308849368.ppt.pdf-第3页.png

第3页 / 共90页

junwr2012-11751638-4744302543308849368.ppt.pdf-第4页.png

第4页 / 共90页

junwr2012-11751638-4744302543308849368.ppt.pdf-第5页.png

第5页 / 共90页

junwr2012-11751638-4744302543308849368.ppt.pdf-第6页.png

第6页 / 共90页

junwr2012-11751638-4744302543308849368.ppt.pdf-第7页.png

第7页 / 共90页

junwr2012-11751638-4744302543308849368.ppt.pdf-第8页.png

第8页 / 共90页

文本预览

需求设计写作培训质量管理部 SQA小组 2005.06

课程范围 u 仅关注如何写作文档 u 不涉及具体的需求分析和设计方法

课程内容 l为什么要文档化 l文档写作基本要求 l需求设计文档模板 l需求文档写作 l设计文档写作

为什么要文档化 Ø 开发人员通过文档化的过程查错补遗； Ø 便于评审，在早期发现技术上的问题； Ø 后续阶段开发任务可能由他人承担，输出文档便于他们开展工作； Ø 维护人员开展维护工作需要； Ø 文档是必要的交付件； Ø ………… 可读性就尤为关键

为什么要文档化 “所有的过程分析都要形成文档。我们现在有一个严重的问题是，大家好像不喜欢写文档，对于需要的实现方案，通常都是一个负责人在脑袋里想想该怎么实现，然后邮件或电话找几个相关人员讨论一下就算可以了，可能连个会议材料或会议纪要都没有。而老外可不是这样的，他们非常非常重视文档，他们认为一个人在脑袋里想的东西是不清晰也不全面的，有时候心里想的认为很正确的方案实际上可能存在致命缺陷。他们要求必须把心里的想法形成文档才能有效的避免这种问题。写文档的过程中，可以更加有效的、更进一步去整理您原来心里的思路，很多问题在您写过文档的过程中您就能发现；另外，文档写作多使用图表，浪费口水的文字尽量少用，和我们一起工作的系统工程师在系统架构分析中就画了五六十张图，就算看不懂他写的英文，从图中我们就能够很清晰的指导整个产品的系统架构。” —— 摘自一位华为员工的瑞典出差报告 5

课程内容 l为什么要文档化 l文档写作基本要求 l需求设计文档模板 l需求文档写作 l设计文档写作

文档写作基本要求下面的文档出自于我们开发人员的手笔，大家觉得如何？

文档写作基本要求 Ø 应使用标准模板写作； Ø 文档封页、页眉页脚、修订记录、附录、参考文献应完善； Ø 关键词、摘要、缩略语应完整； Ø 目录要及时更新； Ø 通篇文档标题、文字格式、间距应协调美观； Ø 所有文档模板中的章节，只可增加，不可删除； Ø 编写建议是用来指导文档写作的，在利用完后要及时删除； Ø 图号置于图形之下，表号置于表格之上；

分享到：

赞收藏

资料库

华为需求与设计工程文档写作(含模版).ppt

相关推荐

开发技术

热门标签

最新资料