软件文档编写(13)

软件文档编写

(4) 其它评审

编排方式。

技术准确度。

覆盖范围的完整性。

对读者的适合程度。

图表设计思想及最终图表（也应接受关于技术准确度、适合程度和完整性的单独评审）。 在语法、标点及其他行文技巧方面的正确性。

对格式和别的标准的遵守程度。

(5) 评审程序

评审通常采用评审会的方式进行。其一般步骤如下。

① 有软件开发单位负责人、用户代表、开发小组成员、科技管理人员和标准化人员等组成 评审小组，必要时还可邀请外单位的专家参加。

② 开会前，由开发单位负责人确定评审的具体内容，并将评审材料发给评审小组成员， 要求做好评审准备。

③ 由开发单位负责人主持评审会，根据文档编制者对该文档的说明和评审条目，由评审 小组成员进行评议、评审，评审结束时应做出评审结论，评审小组成员应在评审结论上签字。

5. 文档的签署

6. 文档归档与保管

7. 文档维护

1.5.7 软件文档的质量要求

缺乏实践经验，缺乏评价文档质量的标准。

不重视文档编写工作，或是对文档编写工作的安排不恰当。

高质量的软件文档应具备以下几个方面的特点。

（1）针对性

（2）精确性

（3）清晰性

（4）完整性

（5）灵活性

（6）可追溯性

1.6 项目开发的文档化

与客户和其他项目组的所有往来必须有记录。

对所有的活动都有一个跟踪落实的过程，比如对所有的审查记录和更改请求都进行标 记，通过跟踪其状态来监督落实情况。

对所有的活动，包括对文档和代码的更改都会有历史记录。

记录都是通过定量的数值或者专业工具加以记录，强调以数据说话，比较准确、客观。

百度搜索“70edu”或“70教育网”即可找到本站免费阅读全部范文。收藏本站方便下次阅读，70教育网，提供经典教育范文软件文档编写(13)在线全文阅读。