|
|
|
《软件文档管理指南》GB/T 16680—1996（NEQ ISO/IEC TR 9294—1990）由原国家技术监督局于1996年12月18日发布，1997年7月1日起实施。
|
|
|
|
该标准为那些对软件或基于软件的产品的开发负有职责的管理者提供软件文档的管理指南。该标准的目的在于协助管理者在他们的机构中产生有效的文档。该标准涉及策略、标准、规程、资源和计划，管理者必须关注这些内容，以便有效地管理软件文档。
|
|
|
|
根据该标准，文档是指一种数据媒体和其上所记录的数据。它具有永久性，并可以由人或机器阅读，通常仅用于描述人工可读的内容，例如技术文件、设计文件和版本说明文件。
|
|
|
|
软件文档的作用：管理依据、任务之间联系的凭证、质量保证、培训与参考、软件维护支持、历史档案。
|
|
|
|
软件文档可归入三种类别：开发文档（描述开发过程本身）、产品文档（描述开发过程的产物）、管理文档（记录项目管理的信息）。
|
|
|
|
|
|
文档计划是指一个描述文档编制工作方法的管理用文档。该计划主要描述要编制什么类型的文档，这些文档的内容是什么，何时编写，由谁编写，如何编写，以及什么是影响期望结果的可用资源和外界因素。
|
|
|
|
|
|
|
|
|
|
|
|
（4）提供编制文档所需要的条件，落实文档编写人员、所需经费以及编制工具等。
|
|
|
|
（5）明确保证文档质量的方法，为了确保文档内容的正确性、合理性，应采取一定的措施，如评审、鉴定等。
|
|
|
|
（6）绘制进度表，以图表形式列出在软件生存期各阶段应产生的文档、编制人员、编制日期、完成日期、评审日期等。
|
|
|
|
此外，文档计划规定每个文档要达到的质量等级，以及为达到期望结果必须考虑哪些外部因素。文档计划还确定该计划和文档的分发，并且明确叙述参与文档工作的所有人员的职责。
|
|
|
|
|
|
开发文档是描述软件开发过程，包括软件需求、软件设计、软件测试、保证软件质量的一类文档，开发文档也包括软件的详细技术描述（程序逻辑、程序间相互关系、数据格式和存储等）。开发文档起到如下5种作用：
|
|
|
|
（1）是软件开发过程中包含的所有阶段之间的通信工具，它们记录生成软件需求、设计、编码和测试的详细规定和说明。
|
|
|
|
（2）描述开发小组的职责。通过规定软件、主题事项、文档编制、质量保证人员以及包含在开发过程中任何其他事项的角色来定义做什么、如何做和何时做。
|
|
|
|
（3）用作检验点而允许管理者评定开发进度。如果开发文档丢失、不完整或过时，管理者将失去跟踪和控制软件项目的一个重要工具。
|
|
|
|
（4）形成了维护人员所要求的基本软件文档。这些支持文档可作为产品文档的一部分。
|
|
|
|
|
|
基本的开发文档有可行性研究和项目任务书；需求规格说明；功能规格说明；设计规格说明，包括程序和数据规格说明；开发计划；软件集成和测试计划；质量保证计划、标准、进度；安全和测试信息。
|
|
|
|
|
|
产品文档规定关于软件产品的使用、维护、增强、转换和传输的信息。产品文档起到如下三种作用：
|
|
|
|
（1）为使用和运行软件产品的任何人规定培训和参考信息。
|
|
|
|
|
|
|
|
|
|
（1）用户。他们利用软件输入数据、检索信息和解决问题。
|
|
|
|
|
|
|
|
|
|
（1）用于管理者的指南和资料，他们监督软件的使用。
|
|
|
|
（2）宣传资料。通告软件产品的可用性，并详细说明它的功能、运行环境等。
|
|
|
|
|
|
基本的产品文档有培训手册；参考手册和用户指南；软件支持手册；产品手册和信息广告。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
这种文档从管理的角度规定涉及软件生存的信息。相关文档的详细规定和编写格式见GB8567。
|
|
|
|
|
|
文档等级是指所需文档的一个说明，它指出文档的范围、内容、格式及质量，可以根据项目、费用、预期用途、作用范围或其他因素选择文档等级。每个文档的质量必须在文档计划期间就有明确的规定，文档的质量可以按文档的形式和列出的要求划分为4级。
|
|
|
|
（1）最低限度文档（1级文档）：适合开发工作量低于一个人月的开发者自用程序。该文档应包含程序清单、开发记录、测试数据和程序简介。
|
|
|
|
（2）内部文档（2级文档）：可用于在精心研究后被认为似乎没有与其他用户共享资源的专用程序。除1级文档提供的信息外，2级文档还包括程序清单内足够的注释以帮助用户安装和使用程序。
|
|
|
|
（3）工作文档（3级文档）：适合于由同一单位内若干人联合开发的程序，或可被其他单位使用的程序。
|
|
|
|
（4）正式文档（4级文档）：适合那些要正式发行供普遍使用的软件产品。关键性程序或具有重复管理应用性质（如工资计算）的程序需要4级文档。4级文档应遵守GB8567的有关规定。
|
|
|
