- GB 16680-1996 软件文档管理指南:信息系统
7.2 规定文档类型和内容
下面给出软件文档主要类型的大纲,
这个大纲不是详尽的或最后的,
但适合作为主要类
型软件文档的检验表。而管理者应规定何时定义他们的标准文档类型。
软件文档归入如下三种类别:
a) 开发文档——描述开发过程本身;
b) 产品文档——描述开发过程的产物;
c) 管理文档——记录项目管理的信息。
7.2.1 开发文档
开发文档是描述软件开发过程,包括软件需求、软件设计、软件测试、保证软件质量的一类文档,开发文档也包括软件的详细技术描述(程序逻辑、程序间相互关系、数据格式和存储
等)。
开发文档起到如下五种作用:
a) 它们是软件开发过程中包含的所有阶段之间的通信工具,
它们记录生成软件需求、
设计、
编码和测试的详细规定和说明;
b) 它们描述开发小组的职责。通过规定软件、主题事项、文档编制、质量保证人员以
及包含在开发过程中任何其他事项的角色来定义做直截了当、如何做和何时做;
c) 它们用作检验点而允许管理者评定开发进度。如果开发文档丢失、不完整或过时,
管理者将失去跟踪和控制软件项目的一个重要工具;
d) 它们形成了维护人员所要求的基本的软件支持文档。而这些支持文档可作为产品文
档的一部分;
e) 它们记录软件开发的历史。
基本的开发文档是:
——可行性研究和项目任务书;
——需求规格说明;
——功能规格说明;
——设计规格说明,包括程序和数据规格说明;
——开发计划;
——软件集成和测试计划;
——质量保证计划、标准、进度;
安全和测试信息。
7.2.2 产品文档
产品文档规定关于软件产品的使用、维护、增强、转换和传输的信息。
产品的文档起到如下三种作用:
a) 为使用和运行软件产品的任何人规定培训和参考信息;
b) 使得那些未参加开发本软件的程序员维护它;
c) 促进软件产品的市场流通或提高可接受性。
产品文档用于下列类型的读者:
——用户 ——他们利用软件输入数据、检索信息和解决问题;
——运行者 ——他们在计算机系统上运行软件;
——维护人员 ——他们维护、增强或变更软件。
产品文档包括如下内容:
——用于管理者的指南和资料,他们监督软件的使用;
——宣传资料 通告软件产品的可用性并详细说明它的功能、运行环境等;
——一般信息 对任何有兴趣的人描述软件产品。
基本的产品文档包括:
——培训手册;
——参考手册和用户指南;
——软件支持手册;
——产品手册和信息广告。
7.2.3 管理文档
这种文档建立在项目管理信息的基础上,诸如:
——开发过程的每个阶段的进度和进度变更的记录;
——软件变更情况的记录;
——相对于开发的判定记录;
——职责定义。
这种文档从管理的角度规定涉及软件生存的信息。
相关文档的详细规定和编写格式见 GB 8567 。
【综合网络信息编辑,版权当属原作者。由于部分网络资料几经转载,很多作品的原作者和来源不详或者不确定,若未标明来源,敬请谅解,请及时联系我们注明!若有侵犯,恳请联系我们,我们将尽快删除!】
━━━━━━━━━━━━● 【转载请注明出处】 ●━━━━━━━━━━━

关注我们:请关注一下我们的微信公众号:扫描二维码
,公众号:乐享空笔记版权声明:本文除注明"转载"外,其它为原创(或源于互联网,由@乐享空笔记整理),其中转载文章版权归原作者所有,欢迎分享本文,转载请保留出处。部分网站内容综合网络信息编辑,版权当属原作者。由于部分网络资料几经转载,很多作品的原作者和来源不详或者不确定,若未标明来源,敬请谅解,请及时联系我们注明!若有侵犯,恳请联系我们,我们将尽快删除!



评论已关闭!