SJ 20523-1995.Guideline for software documentation management.
1范围
1.1主题内容
SJ 20523性技术文件规定了软件文档种类、质量等级以及文档管理的详细要求。
1.2 适用范围
SJ 20523性技术文件适用于软件的开发、使用和维护。
2引用文件
GB 8566--88计算机软件开发规范
GB 8567- -88计算机软件产品开发文件编制指南
GB/T 11457- -89软件工程术语
GJB 437--88军用软件开发规范
GJB 438-88军用软件文档编制规范
3定义
除下列定义外,其它定义见GB/T 11457。
3.1 文档计划
documentation plan
一个描述文档编制工作方法的管理用文档。该计划主要描述要编制佬类型的文档,这些文档的内容是什么,何时编写,由谁编写,如何编写,以及什么是影响期望结果的可用资源和外界因素。
3.2文档等级level of documentation
对所需文档的一个说明,它指出文档的范围、内容、格式及质量。可以根据项目、费用、预期用途、作用范围或其它因素选择文档等级。
4一般要求
软件文档是描述软件产品开发及开发结果、使产品能有效地使用或在合适的时候使产品能转换或移植到其它环境的所有可复制又便于人们使用的资料。
软件文档有六个重要功能:管理依据;任务之间联系的工具;质量保证;教育与参考;软件维护支持;历史档案。
软件文档分为开发文档和产品文档两类。