计算机软件文档编制规范

《计算机软件文档编制规范》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、冯惠GB/T8567-2006计算机软件文档编制规范目次1修订背景２　修订依据３　新老版本的差异４　新版标准结构５　文档编制过程６　文档编制要求７　文档编制格式８　小结一、本标准修订的背景ＧＢ／Ｔ８５６７－１９８８版是参考英国某公司的文档标准，结合当时国内软件开发的经验，而且主要是针对瀑布模型的开发方法而制定的。该标准的发布与实施对我国上世纪八十年代、九十年代的软件开发发挥了重要作用。但随着时间的推移，软件工程技术的发展与提高，目前来看，８８版已经不适应软件产业发展的需要，因此修订ＧＢ／Ｔ８５６６－１９８８版势在必行。二、GB/T8567-200

2、6制定的依据主要依据：ＧＢ／Ｔ８５６６－２００１　信息技术　软件生存周期过程ＳＪ／Ｔ２０７７８－２０００　软件开发与文档编制ＩＳＯ／ＩＥＣ１５９１０：１９９９　信息技术　软件用户文档过程三、ＧＢ／Ｔ８５６７新老版本的主要差异ＧＢ／Ｔ８５６７－１９８８主要适用于瀑布模型开发方法ＧＢ／Ｔ８５６７－１９８８给出了１４种文档的编制格式要求：１）可行性研究报告２）项目开发计划３）软件需求说明书ＧＢ／Ｔ８５６７新老版本的主要差异４）数据要求说明书５）概要设计说明书６）详细设计说明书７）数据库设计说明书８）用户手册９）操作手册１０）模块开发卷宗１１）测试计划１

3、２）测试分析报告１３）开发进度月报１４）项目开发总结报告ＧＢ／Ｔ８５６７新老版本的主要差异ＧＢ／Ｔ８５６７－２００6原则上适用于各种类型的开发方法ＧＢ／Ｔ８５６７－２００6描述了文档编制过程ＧＢ／Ｔ８５６７－２００6给出２５种文档的编制格式要求１）可行性分析（研究）报告２）软件开发计划３）软件测试计划４）软件安装计划ＧＢ／Ｔ８５６７新老版本的主要差异５）软件移交计划６）运行概念说明７）系统／子系统需求规格说明８）接口需求规格说明９）系统／子系统设计（结构设计）说明１０）接口设计说明１１）软件需求规格说明１２）数据需求说明１３）软件（结构）设计说明

4、ＧＢ／Ｔ８５６７新老版本的主要差异１４）数据库（顶层）设计说明１５）软件测试说明１６）软件测试报告１７）软件配置管理计划１８）软件质量保证计划１９）开发进度月报２０）项目开发总结报告ＧＢ／Ｔ８５６７新老版本的主要差异２１）软件产品规格说明２２）软件版本说明２３）软件用户手册２４）计算机操作手册２５）计算机编程手册另外给出了面向对象的１０种文档的编制格式要求四、ＧＢ／Ｔ８５６７－２００6标准结构１、范围２、规范性引用文件３、术语和定义４、缩略语５、文档（编制）过程６、文档编制要求７、文档编制格式附录Ａ　面向对象软件的文档编制五、文档（编制）过程5.

5、1概述有两种主要类型的标准：a.产品标准，它规定产品的特征和功能需求；b.过程标准，它规定开发产品的过程。应用程序和计算机软件的复杂性日益增加，使得给使用计算机的用户提供完整的、正确的和易懂的文档的需要更加迫切。本标准通过规定影响软件文档的质量的活动（做什么和由谁做），提供达到这些目的的工具。文档常常是关心在软件已经实现后做些什么。然而，为了质量，软件文档编制应作为整个软件生产过程的一部分。过程计划应把文档计划包括在内。本标准也给用户和客户提供工具以保证文档过程实施。本标准的主要活动之一是建立开发文档的广泛计划。这是必须的，因为有计划，文档编制的

6、质量会更好，过程的效率会更高。为遵循本标准，计划必须包括风格规格说明。本标准不规定风格规格说明的内容（即不规定具体的布局和字体），但它规定风格规格说明必须覆盖什么。本标准也规定何种信息对于文档管理者是可用的和谁做评审和再生产文档。5.2文档（编制）过程的关注点文档编制计划文档开发（编制）文档评审5.3文档计划5.3.1概要文档管理者应准备一文档计划，此计划规定在文档创建中要执行的工作。此文档计划应经需方正式同意，以预示它完全覆盖了需方的要求。l文档计划通常将覆盖整个文档系列。文档计划应正式地描述计划的文档的范围和限制，以及重要的文档分析和设计决定

7、。也应规定在文档开发期间实现的过程和控制。文档计划应包括（但不限于）以下内容：a）计划的文档的工作名称、目的、范围和限制。b）文档的预定的读者，和使用的目的。c）文档内容的草案表，带有估计的页数和其他媒体的等效细节。d）交付：打印副本数，是否提供电子副本，磁盘和文件格式（包括软件版本）和在何处交付。e）版权的拥有者和任何其他所有权。l这是复杂的问题，应在合同中规定。f）适当处，包括每个文档的安全或机密级。g）管理文档开发过程的步骤和控制，包括存储、检索、后备、处理和质量保证（若要求）。h）所用的生产方法、工具和工具版本。i）文档开发人员所在的队伍

8、的结构，任选地，包括队伍选择计划。l在文档编写和生产的不同阶段中的工作人员，需要不同的技巧。编写人员可能要求对正在编写的系统有好的知识加