文档介绍：需求设计写作培训质量管理部 SQA 小组课程范围?仅关注如何写作文档?不涉及具体的需求分析和设计方法课程内容?为什么要文档化?文档写作基本要求?需求设计文档模板?需求文档写作?设计文档写作为什么要文档化?开发人员通过文档化的过程查错补遗; ?便于评审,在早期发现技术上的问题; ?后续阶段开发任务可能由他人承担,输出文档便于他们开展工作; ?维护人员开展维护工作需要; ?文档是必要的交付件; ?…………可读性就尤为关键为什么要文档化“所有的过程分析都要形成文档。我们现在有一个严重的问题是, 大家好像不喜欢写文档,对于需要的实现方案,通常都是一个负责人在脑袋里想想该怎么实现,然后邮件或电话找几个相关人员讨论一下就算可以了, 可能连个会议材料或会议纪要都没有。而老外可不是这样的,他们非常非常重视文档,他们认为一个人在脑袋里想的东西是不清晰也不全面的,有时候心里想的认为很正确的方案实际上可能存在致命缺陷。他们要求必须把心里的想法形成文档才能有效的避免这种问题。写文档的过程中,可以更加有效的、更进一步去整理您原来心里的思路,很多问题在您写过文档的过程中您就能发现; 另外,文档写作多使用图表,浪费口水的文字尽量少用,和我们一起工作的系统工程师在系统架构分析中就画了五六十张图, 就算看不懂他写的英文,从图中我们就能够很清晰的指导整个产品的系统架构。”——摘自一位华为员工的瑞典出差报告 5 课程内容?为什么要文档化?文档写作基本要求?需求设计文档模板?需求文档写作?设计文档写作文档写作基本要求下面的文档出自于我们开发人员的手笔,大家觉得如何? 文档写作基本要求?应使用标准模板写作; ?文档封页、页眉页脚、修订记录、附录、参考文献应完善; ?关键词、摘要、缩略语应完整; ?目录要及时更新; ?通篇文档标题、文字格式、间距应协调美观; ?所有文档模板中的章节,只可增加,不可删除; ?编写建议是用来指导文档写作的,在利用完后要及时删除; ?图号置于图形之下,表号置于表格之上; 文档写作基本要求?应追求图文并茂的效果; ?句子和段落要短; ?使用语言应严谨,不要使用白话; ?采用主动语气; ?不要出现“我们”、“你们”、“他们”这样的称谓,或“这个”、“那个”这样的词,应使用“本×× ”、“该×× ”、“其”; ?表述清晰,避免引起歧义; ?通篇文档细节上要保持一致; 练****房子南北走向,房子大门在东侧中间位置。门厅长约 3米, 宽2米,门厅左面是主卧室,右面是厨房。厨房 3米宽, 4米长, 厨房门对着门厅,厨房的顶头还有一个北阳台,与厨房同宽, 长1米。主卧室宽 3米,长 5米左右,房间门对着客厅。客厅与餐厅连为一体,共 7米长, 4米宽,与客厅相连有一南阳台,与客厅同宽,长米。餐厅的北面是卫生间,卫生间与厨房相对, 中间由 1米宽, 3米长的过道隔开;卫生间门对着过道,南墙与厨房的南墙在一条直线上;卫生间为长方形,南墙长 3米,另一边长 2米。卫生间的北面是次卧,同宽,门朝着过道,次卧长 4 米。过道的北端是书房门,书房南北长 4米,书房有一个一米见方的门厅,书房的西墙长 4米,包括 1米长的门厅长度,西墙把书房和次卧分隔开。门厅东墙北端 90角折向东,长 2米,把书房和厨房北阳台分隔开。大家认为下面的描述如何? 究竟长多少? ? 是左? 还是右? 大段的叙述, 不利于理解! 10