笔记-知识产权与标准化知识-开发文档-产品文档-管理文档

信管网：http://www.cnitpm.com/pm1/45576.html
GB/T16680—1996查到已经作废了，最新貌似GB/T16680—2015 ，这个里面没以下的定义了【———删除了第7章制定文档编制标准和指南;】http://www.csres.com/detail/56485.html
GB/T16680—2015 http://www.cnitpm.com/pm1/45577.html
GB/T16680—1996 https://max.book118.com/html/2018/1109/8123101067001132.shtm

软件文档归入如下三种类别：

• 开发文档，描述开发过程本身
• 产品文档，描述开发过程的产物
• 管理文档，记录项目管理的信息

1. 开发文档

开发文档是描述软件开发过程，包括软件需求、软件设计、软件测试、保证软件质量的一类文档，开发文档也包括软件的详细技术描述、程序逻辑程序间相互关系、数据格式和存储等。

开发文档起到如下五种作用：

1. 它们是软件开发过程中包含的所有阶段之间的通信工具，它们记录生成软件需求设计编码和测试的详细规定和说明；
2. 它们描述开发小组的职责，通过规定软件主题事项文档编制质量保证人员以及包含在开发过程中任何其他事项的角色来定义做什么、如何做和何时做；
3. 它们用作检验点而允许管理者评定开发进度。如果开发文档丢失、不完整或过时，管理者将失去跟踪和控制软件项目的一个重要工具；
4. 它们形成了维护人员所要求的基本的软件支持文档，而这些支持文档可作为产品文档的一部分；
5. 它们记录软件开发的历史。

开发文档有：

a) 可行性研究和项目任务书
b) 需求规格说明
c) 功能规格说明
d) 设计规格说明，包括程序和数据规格说明
e) 开发计划
f) 软件集成和测试计划 ▲▲▲
g) 质量保证计划、标准、进度 ▲▲▲
h) 安全和测试信息

2. 产品文档

产品文档规定关于软件产品的使用维护增强转换和传输的信息。

产品的文档起到如下三种作用：

1. 为使用和运行软件产品的任何人规定培训和参考信息；
2. 使得那些未参加开发本软件的程序员维护它；
3. 促进软件产品的市场流通或提高可接受性。

产品文档用于下列类型的读者：

1. 用户他们利用软件输入数据检索信息和解决问题；
2. 运行者他们在计算机系统上运行软件；
3. 维护人员他们维护增强或变更软件。

产品文档包括如下内容：

1. 用于管理者的指南和资料他们监督软件的使用；
2. 宣传资料通告软件产品的可用性并详细说明它的功能运行环境等；
3. 一般信息对任何有兴趣的人描述软件产品。

基本的产品文档包括：

1. 培训手册
2. 参考手册和用户指南
3. 软件支持手册
4. 产品手册和信息广告

3. 管理文档

这种文档建立在项目管理信息的基础上，这种文档从管理的角度规定涉及软件生存的信息。诸如：

1. 开发过程的每个阶段的进度和进度变更的记录；▲▲▲
2. 软件变更情况的记录；
3. 相对于开发的判定记录；
4. 职责定义。