目录
1. 前言 ...................................................................................................................................................1
1.1 目的 ......................................................................................................................................1
1.2 术语 ......................................................................................................................................1
1.3 参考文献 ..............................................................................................................................1
1.4 版本说明和修改历史 ..........................................................................................................1
2. 软件文档 ...........................................................................................................................................1
2.1 文档的定义及作用 ..............................................................................................................1
2.2 软件文档的分类 ..................................................................................................................2
2.3 软件文档的制作与软件生存周期之间的关系 ..................................................................3
2.4 文档的使用者 ......................................................................................................................3
3. 文档编制格式规范...........................................................................................................................4
3.1 文档编码规则 ......................................................................................................................4
3.2 文档组成格式 ......................................................................................................................4
3.2.1
封面
..........................................................................................................................5
3.2.2
目录
..........................................................................................................................6
3.2.3
版本更新说明
..........................................................................................................6
3.2.4
文件内容
..................................................................................................................6
3.2.5
正文格式
..................................................................................................................7
3.3 文档制作工具 ......................................................................................................................7
4. 文档管理规范 ...................................................................................................................................7
4.1 文档管理岗位职责 ..............................................................................................................7
4.2 文档的制作 ..........................................................................................................................8
4.2.1
文档的分类、编码与标识
......................................................................................8
4.2.2
文档的作者、修改者和打字者
..............................................................................8
4.3 文档的收集 ..........................................................................................................................8
4.4 文档的配置 ..........................................................................................................................9
4.5 文档的控制 ..........................................................................................................................9
4.6 文档的修改管理 ..................................................................................................................9
4.7 文档的借阅和复制管理制度 ............................................................................................10
4.8 文档的保密性 ....................................................................................................................10
5. 技术文档的质量评价.....................................................................................................................11
