计算机软件档编制规范1.ppt

计算机软件文档编制规范 中标软件公司 周明德 5 文档过程 5.1 概述 有两种主要类型的标准： a. 产品标准，它规定产品的特征和功能需求； b. 过程标准，它规定开发产品的过程。 文档标准就是一种过程标准。 应用程序和计算机软件的复杂性日益增加，使得给使用计算机的用户提供完整的、正确的和易懂的文档的需要更加迫切。本标准通过规定影响软件文档的质量的活动（做什么和由谁做），提供达到这些目的的工具。 文档常常是关心在软件已经实现后做些什么。然而，为了质量，软件文档编制应作为整个软件生产过程的一部分。过程计划应把文档计划包括在内。本标准也给用户和客户提供工具以保证文档过程实施。 本标准的主要活动是建立开发文档的广泛计划。这是必须的，因为有计划，文档编制的质量会更好，过程的效率会更高。本标准也规定何种信息对于文档管理者是可用的和谁做评审及谁生产文档。 本标准遵循GB/T 8566－2001《信息技术 软件生存周期过程》。为其开发过程和管理过程中的主要文档规定了编制规范。 本标准是按文档由专门的文档管理人员和文本编写人员的模式规定的。具体的项目可根据具体情况安排。 文档过程的活动应按图5－1中的顺序执行。 其中，有两个阴影框。在一个阴影框中的所有活动应在下一个阴影框中的活动开始之前完成。在阴影框中的活动可以并行执行。虚线指示可能的重复。 在文档的最小内容已经由需方规定的情况下，这宜由文档管理者在文档计划开发期间纳入总数中。 5.2 源材料准备 需方应允许文档管理者访问以下内容： a）所有有关的规格说明、记录格式、屏幕和报告布局、CASE 工具输出和文档的准备所需要的任何其他的信息； b）若可用，软件的操作副本； c）软件的分析员和程序员，以及及时和确切地解答由文档开发人员提出的问题； d）若可能，访问典型的用户（为了做读者分析和可用性测试）。 为了增加对产品和它的读者的了解，对软件开发人员的访问是必要的但使这样的访间保持到最小是文档管理者的责任。 不管文档管理者是否是软件的开发者，需方应提供适用的标准、风格和格式指南和其他相关的材料（除非，通常可用的）。文档管理者应分发这些材料至需要它的文档开发人员。 保证需方交付给文档管理者的所有材料，当交付时，是完整的和正确的且在交付后保持是最新的，这是需方的责任。 需方保证，提供的材料没有一个违反任何其他部门的知识产权。 文档管理者应采取所有有理由的步骤，以保证由需方提供的材料保持在很好的状态，应保证需方要求的信息安全并在文档项目完成后，所有材料返回给需方。 在某些情况下，不是所有材料需要返回；这应在合同中定义。在某些情况下，由需方传送给文档管理者的材料要求保持机密的和安全的。合同宜规定对于传送给文档管理者的材料，需方要求文档管理者的机密和安全等级。 5.3 文档计划 5.3.1 概要 文档管理者应准备一文档计划，此计划规定在文档创建中要执行的工作。此文档计划应经需方正式同意，以预示它完全覆盖了需方的要求。 文档计划应正式地描述计划的文档的范围和限制，以及重要的文档分析和设计决定。也应规定在文档开发期间实现的过程和控制。 文档计划应包括（但不限于）以下内容： a）计划的文档的工作名称、目的、范围和限制。 b）文档的预定的读者，和使用的目的。 c）文档内容的草案表，带有估计的页数和其他媒体的等效细节。 d）交付：打印副本数，是否提供电子副本，磁盘和文件格式（包括软件版本）和在何处交付。 e）版权的拥有者和任何其他所有权。 f）适当处，包括每个文档的安全或机密级。 g）管理文档开发过程的步骤和控制，包括存储、检索、后备、处理和质量保证（若要求）。 h）所用的生产方法、工具和工具版本。 i）文档开发人员所在的队伍的结构，任选地，包括队伍选择计划。 j）项目依赖。 k）所要求的人时和成本。 l）项目资源需求，包括需方提供的信息和其他资源。 m）在软件开发期间，软件变更传送信息给文档管理者的方法。 n）文档的变更控制和维护的计划（任选）。 o）实现后评审的计划（任选）。 p）显示适当的里程碑的时间表，包括： 1）文档计划批准； 2）每个草案的准备、评审和改正； 3）可用性测试； 4）打印、装订和发布。 若适当，这些活动的每一个对于文档的每一项应重复。 文档计划宜在文档的开发开始以前准备与批准，以保证所有部门同意目标和所用的方法。批准后，计划宜尽可能广泛地分发；分发宜包括所有文档开发