本书系统、全面地介绍了软件编档的概念、方法、规范、格式、技巧、工具及其管理，按照软件生命周期理论并结合相关软件工程标准，完整讲述了各类软件文档从规划、计划、编档、测试、评审、管理直至打包、印刷、发行、维护等的全过程，是目前国内难得的专业介绍软件编档的教材及工具书籍。

本书深入浅出、通俗易懂、循序渐进，理论联系实际，力求突出重点，侧重应用，具有丰富的案例和编档模板。不仅对缺乏经验的编档者极有教益，即使有丰富软件开发、管理经验的人，也同样会从中获取规范、系统的编档思想、理念和良好的处理方法。本书对于非软件领域的各类文档编制工作，也有一定的参考价值和指导意义。

本书不仅可作为各类高校本科生、研究生软件编档课程的教材和教学参考书，也可供各级各类培训机构作为继续教育的教材，更是广大软件工程人员、IT从业人员和管理人员充实、提高自我的极好的案头工具书。

软件编档作为软件工程的一个重要组成部分，已经越来越受到人们的重视。特别是在大中型软件项目的开发领域，随着软件复杂度的急剧增加，对软件开发过程系统化、规范化和标准化的要求越来越严格，需要软件开发过程进行永久记录的思维火花、活动过程和阶段性成果也越来越多。

软件文档不仅是软件开发人员和软件用户之间进行通信和交流的工具，更是软件开发过程管理和运行维护管理不可或缺的重要依据。

在软件项目的开发和管理工作中，严格遵守软件工程标准，规范软件编档，具有十分重要的意义和相当大的工作量。高质量、高效率的编制、分发、管理和维护文档，及时地变更、修正、扩充和使用文档，对于软件产品的设计开发、发行使用、变更维护、转让移植、二次开发等，对于充分发挥软件产品的效益，都有着十分重要的意义。

具体地说，一个软件项目的开发过程就是一个系统工程的实施过程。任何一个软件项目的开发完成，从问题的提出到软件最终开发成功，都要经历几个开发阶段，每个开发阶段都会根据需要形成一系列的阶段性文件。各个阶段的文件都要记载本阶段工作的方法、过程和结果，并对下一阶段的工作进行宏观控制或对软件的开发和使用进行具体的指导。

因此，对某个具体软件项目的开发过程同步完成相对应的软件编档工作，实际上就是依据软件工程学的原理、原则和方法，有组织、有计划地实施和记录软件项目的研究开发过程、科学管理过程和应用维护过程。

一个软件项目的成功开发完成，不仅依赖于众多设计思想构架的系统逻辑结构和巧妙的信息流、控制流衔接技术，而且更需要开发小组成员的共同努力。因此，在有多人参加的软件项目开发小组中，将“不可见”的设计思想和设计技巧显现成“可见”、可阅读、可沟通、可交流的东西，“文档”是重要的载体，也是软件开发工作赖以进行的重要依据。

第1章软件文档概述

1.1为什么需要软件文档

1.2软件文档的定义

1.3软件文档的地位和作用

1.4软件文档的分类

1.5软件文档的使用

1.6软件编档与软件生命周期

讨论题

第2章软件工程标准化

2.1软件工程标准化

2.1.1什么是“标准”

2.1.2软件工程标准化

2.1.3软件工程标准化的意义

2.2软件工程标准分类

2.2.1按标准的类型划分

2.2.2按标准的范围划分

2.3中国国家软件工程标准

2.3.1基础标准

2.3.2开发（包括维护）标准

2.3.3文档标准

2.3.4管理标准

2.4软件工程标准的层次

2.4.1国际标准

2.4.2国家标准

2.4.3行业标准

2.4.4企业规范

2.4.5项目规范

2.5软件工程标准的制定与推行

2.6在开发机构中推行软件工程标准

2.7ISO 9000国际标准

2.7.1ISO 9000标准概述

2.7.2ISO 9000标准的特点

2.7.3ISO 9000标准的内容

2.7.4ISO 9000系列标准的主导思想

2.7.5质量保证标准之间及其与质量管理标准的关系

2.7.6ISO 90003及其对软件质量保证的要求

2.8软件工程标准化与软件文档的关系

讨论题

第3章软件视图和文档风格

3.1软件视图的概念和类型

3.2软件视图类型

3.3软件文档风格的概念

3.4软件文档风格指导

3.5模块视图及文档风格

3.5.1模块视图类型

3.5.2模块视图类型的文档风格

3.5.3模块视图类型风格编档评估

3.6组件和连接器（C&C）视图及文档风格

3.6.1C&C视图类型

3.6.2C&C类型的文档风格

3.6.3C&C视图类型风格编档评估

3.7分配视图类型及文档风格

3.7.1分配视图类型

3.7.2分配视图类型的文档风格

3.7.3分配视图类型风格编档评估

讨论题

第4章软件文档表达

4.1软件文档的编制原则

4.2合理文档的7条规则

4.3文档表达的载体

4.3.1纸质文档

4.3.2自动文档

4.4软件文档的涉众

4.4.1项目经理

4.4.2分析人员

4.4.3开发人员

4.4.4基础结构支持人员

4.4.5应用程序开发人员

4.4.6测试人员和集成人员

4.4.7维护人员

4.4.8客户

4.4.9最终用户

4.4.10新的涉众

4.4.11未来系统设计师

4.4.12其他系统的设计人员

4.5软件文档内容组织

4.5.1确定可能的组织类型

4.5.2确定所有的组织方式

4.5.3摘要

4.5.4建立初步的文档组织内容表

4.5.5组织文档的要点

4.6选择文档表达方法

4.6.1选择文档视图表达方式

4.6.2选择文档写作表达方式

4.7国际化软件开发编档

4.7.1国际化软件开发编档的基本要求

4.7.2国际化软件开发编档的基本准则

4.8软件本地化工程文档处理

4.8.1软件本地化工程的目的

4.8.2软件本地化工程及文档处理的内容

4.8.3软件本地化工程及文档处理的流程

4.8.4软件本地化工程文档处理的工具

4.8.5软件本地化工程文档处理的人员

第5章软件编档的要求

5.1有关系统开发生命周期文档的讨论

5.2软件编档的灵活性

5.2.1编制文档的种类

5.2.2文档的详细程度

5.2.3文档的扩展

5.2.4章节的展开与缩并

5.2.5程序设计表达

5.2.6文档内容表达

5.2.7文档的其他种类

5.3制定编档策略

5.4制定编档计划

5.5建立编档规范

5.5.1软件编档规范的制定及用途

5.5.2软件编档规范的结构

5.5.3软件编档规范的应用

5.6软件编档步骤

5.6.1制定软件编档计划

5.6.2文档编制

5.6.3文档编号

5.6.4文档评审

5.6.5文档签署

5.6.6文档归档与保管

5.6.7文档维护

5.7软件编档的质量要求

5.7.1影响软件编档质量的主要问题

5.7.2从质量保证的角度对编档提出的要求

5.7.3支持软件编档的措施

5.8软件编档技巧

5.8.1使用简洁的表达

5.8.2采用主动语态动词

5.8.3使用有效的语法规则和标点

5.9确定软件编档种类的两个实例

第6章软件开发文档

6.1开发文档概述

6.1.1软件开发文档的种类

6.1.2软件项目生命周期开发文档的编制

6.2可行性分析报告

6.2.1项目可行性分析的任务和要求

6.2.2项目可行性分析的内容

6.2.3可行性分析报告的主要描述方法

6.2.4可行性分析报告的评审

6.2.5项目开发计划

6.3软件需求文档

6.3.1软件需求编档的任务和要求

6.3.2软件需求编档的原则

6.3.3软件需求编档的内容

6.3.4软件需求编档的主要方法

6.3.5软件需求编档的重点

6.3.6软件需求编档的常见问题

6.3.7软件需求文档的评审

6.4软件概要设计文档

6.4.1结构化设计编档

6.4.2面向对象设计编档

6.4.3概要设计编档的内容

6.5软件详细设计文档

6.5.1详细设计编档方法

6.5.2详细设计编档的内容

第7章软件管理文档

7.1管理文档概述

7.2项目开发计划

7.2.1项目开发计划书的内容

7.2.2项目工作分解结构

7.2.3项目里程碑和阶段性文档

7.2.4项目进度估算和计划

7.2.5项目计划的图表描述方法

7.2.6项目风险管理

7.3软件测试文档

7.3.1软件和软件文档的测试

7.3.2软件测试计划的导出和内容

7.3.3软件测试编档的几种常用图表工具

7.3.4软件测试方法设计

7.3.5软件测试计划

7.3.6软件测试分析报告

7.4项目开发进度报告

7.4.1项目状态报告的类型

7.4.2开发进度偏差

7.4.3报告的图形工具

7.4.4成本进度控制描述

7.4.5项目进度报告的主要内容

7.4.6项目变更报告

7.5项目开发总结报告

第8章软件用户文档

8.1用户文档编制的基本要求

8.2软件常用表示形式

8.2.1系统部件模型的文档表示

8.2.2对话设计的文档表示

8.3用户手册

8.4操作手册

8.4.1引言

8.4.2操作原理

8.4.3操作说明

8.4.4注意事项

8.4.5附录

8.5软件维护文档

8.5.1软件运行系统的结构

8.5.2软件维护方案

8.5.3软件维护与变更

8.5.4软件维护建议

第9章软件文档发行

9.1完善文档

9.1.1核对和编辑文档

9.1.2使用图表

9.1.3使用例子

9.2文档定稿

9.2.1文档定稿

9.2.2文档序言定稿

9.2.3文档正文定稿

9.2.4文档附录定稿

9.2.5文档最后定稿

9.3文档测试

9.3.1提交读者测试

9.3.2编档者自行测试

9.4文档评审

9.4.1确定评审人

9.4.2要有多层次的评审人

9.4.3确定评审后修改的步骤

9.4.4修改的部分仍然需要送审

9.4.5准备好审稿者的签名表

9.4.6定出审稿的步骤

9.4.7评审文档的要点

9.5制作软件文档包

9.5.1采用一个文档还是若干文档

9.5.2文档包组织模板

9.5.3如何组织文档才能满足涉众需要

9.5.4文档包的实施和支持

9.5.5文档包制作总结评估

9.6发行文档

9.6.1确定文档的装帧形式

9.6.2将文档分发给涉众

9.7培训与用户支持

9.7.1制定培训计划和开展培训活动

9.7.2进行中的培训和用户支持活动

9.8更新文档

9.8.1制定文档更新步骤

9.8.2如何确定文档是否更新

第10章软件编档管理

10.1软件编档管理及方法

10.1.1软件编档的管理

10.1.2文档的分类与标识

10.1.3软件文档的管理和控制

10.2软件文档维护

10.2.1软件文档维护的方法

10.2.2软件文档维护的管理

10.3动态文档管理

10.4文档质量评审

10.4.1建立明确的文档质量目标

10.4.2使用提高文档质量的技术和工具

10.4.3进行明确的质量保证评审

10.5软件编档的风险及防范

10.6软件编档的组织管理

10.6.1制定文档编档策略

10.6.2制定文档编档标准和规范

10.6.3制定文档编档计划

10.6.4制定文档编档规程

10.6.5软件文档的管理方式

10.7项目管理软件

附录A软件产品开发文件编制的国家标准及模板

附录B标准名称缩写列表

附录C案例——移动BOSS系统技术文档（部分）

参考文献