华为需求与设计工程文档写作技术报告.ppt

* 关于详略的问题，是否需要描述清楚函数的所有逻辑分支，应根据实际情况决定。一般而言，要求编码时相对于LLD，函数的处理不应该再增加如if, else, case等逻辑分支。 如果负责编码的人对LLD不熟悉的话，就要求LLD写得详细些，否则，只需要将函数的关键算法描述清楚即可。 * 前面需求建模样例为“在DOS环境下模拟实现ATM柜员机”，此样例为该项目的HLD。 * 我们目前对待文档写作的态度：内心上抵触、应付了事。 反观老外在这方面的认真态度，我们不但需要文档化，还需要将文档化做好。 * 开发人员写文档常犯的低级错误： 1.不使用标准模板； 2.文档各部分内容不全，关键词、摘要、缩略语、文档标题、页眉页脚中错误非常多，让人没有再看下去的心情； 3.文档标题、字体格式混乱，层次不清； 4.编写建议在文档完成后仍然保留。 * 关于格式，应尽可能使用模板自带的格式，如：标题1～4、正文首行缩进、表格文本、代码、图号等。 * 主动语气、被动语气： “本模块提供××功能”； “××功能被本模块提供”。 * 该练习突出基本要求中的几点： 1.句子和段落要短； 2.避免歧义； 3.应追求图文并茂的效果。 * 只是简单地进行了分段，阅读起来更有层次感更清晰。同时修正了“约”、“左右”等模糊的描述。 * 图形表述方式理解更容易，上图已将房间布局信息很清晰表达出来，缺的是尺寸信息，可以在图中标