软件文档编写
3. 运行时期
编写软件问题报告、软件修改报告。
1.2 软件文档的作用
1. 管理依据
2. 任务之间联系的凭证
3. 质量保证
4. 培训与参考
5. 软件维护支持
6. 历史档案
1.3 软件文档分类
一般说来, 软件文档可分为以下三种类别:
开发文档——描述开发过程本身。
产品文档——描述开发过程的产物。
管理文档——记录项目管理的信息。
1.3.1 开发文档
开发文档是描述软件开发过程, 包括软件需求、软件设计、软件测试、保证软件质量的一 类文档, 开发文档也包括软件的详细技术描述（程序逻辑、程序间的相互关系、数据格式和存储等）。
开发文档所起的作用可归纳如下:
它们是软件开发过程中包含的所有阶段之间的通信工具, 它们记录生成软件需求、设 计、编码和测试的详细规定和说明。
它们描述开发小组的职责。通过规定软件、主题事项、文档编制、质量保证人员以及 包含在开发过程中任何其他事项的角色来定义如何做和何时做。
它们用作检验点而允许管理者评定开发进度。如果开发文档丢失、不完整或过时, 管 理者将失去跟踪和控制软件项目的一个重要工具。
它们形成了维护人员所要求的基本的软件支持文档。而这些支持文档可作为产品文档 的一部分。
它们记录软件开发的历史。
基本的开发文档是:
可行性研究和项目任务书。
软件需求规格说明。
软件功能规格说明。
软件设计规格说明, 包括程序和数据规格说明。
开发计划。
软件集成和测试计划。
质量保证计划、标准、进度。
安全和测试信息。
1.3.2 产品文档
产品文档规定关于软件产品的使用、维护、增强、转换和传输的信息。产品文档起到如下 作用:
为使用和运行软件产品的任何人规定培训和参考信息。
使得那些未参加开发本软件的程序员维护它。
促进软件产品的市场流通或提高可接受性。
产品文档用于下列类型的读者:
