2014软件文档管理指南.pptVIP

* 十进分类法 十进分类编号方法。这种方法就是将产品的设计文件按规定的技术特征（功能、结构、材料、用途、工艺特征），分为10级，每级分为10类，每类分为10型，每型又分为10种。在特征标记前，冠以汉语拼音字母表示企业区分代号，在特征标记后，标上三位数字，表示登记号，最后是文件简号。 例: AB 2.022.005 MX AB 2.022 .005 MX 企业代号 级类型种 登记顺序号 文件简号 * 隶属编号法 隶属编号,即按隶属关系编号,下级编号应在其所属上级的范围内编号 * 4. 文档评审 文档评审十分重要，必须与技术评审结合起来 为了提高软件产品的质量，一个有效的方法就是在软件开发的每个阶段，对该阶段所形成的文档进行严格的评审，这样可尽早发现问题，并及时采取措施予以解决，从而确保文档内容的正确性，避免或减少大的返工，同时为进入下一阶段的工作做好组织上和技术上的准备。 * 文档评审 对一些大项目，正规评审通常在开发方法学指导下进行。正规评审应包括文档评审，这是为了保证文档不但正确，而且内容是最新的。如果对文档与开发工作的其他方面同样重要这一点强调不够，各种问题可能随之而来。 对所有描述开发工作和产品的文档进行评审是正规评审过程的组成部分。一开始特别重要的是需求规格说明和设计规格说明的评审。 * (1) 需求评审 需求评审进一步确认开发者和设计者已了解用户要求什么，及用户从开发者一方了解某些限制和约束。 需求评审(可能需要一次以上)产生一个被认可的需求规格说明。基于对系统要做些什么的共同理解，才能着手详细设计。用户代表必须积极参与开发和需求评审，参与对需求文档的认可。 * (2) 设计评审 通常安排两个主要的设计评审 概要设计评审 在概要设计评审过程中，主要详细评审每个系统组成部分的基本设计方法和测试计划。系统规格说明应根据概要设计评审的结果加以修改 详细设计评审 主要评审计算机程序和程序单元测试计划 * 设计评审 设计评审产生的最终文档规定系统和程序将如何设计、开发和测试，以满足一致同意的需求。正规备忘录提供一份有关所有会议的记录。 * (3) 其他评审 其他文档的正规评审也是必需的。 产品文档的计划应包括对下述内容的评审和认可： 编排方式 技术准确度 复盖范围的完整性 对读者的适合程度 图表设计思想及最终图表(也应接受关于技术准确度、适合程度和完整性的单独评审) 在语法、标点及其他行文技巧方面的正确性 对格式和别的标准的遵守程度 * 评审会步骤 由软件开发单位负责人、用户代表、开发小组成员、科技管理人员和标准化人员等组成评审小组，必要时还可邀请外单位的专家参加； 开会前由开发单位负责人确定评审的具体内容，并将评审材料发给评审小组成员，要求做好评审准备 由开发单位负责人主持评审会，根据文档编制者对该文档的说明和评审条目，由评审小组成员进行评议、评审，评审结束应作出评审结论，评审小组成员应在评审结论上签字。 * 5. 文档签署 软件产品的所有文档，都应按规定进行签署 软件文档签署的顺序一般按“编写一审核－会签－标准化－批准”的顺序进行。会签仅在必要时才进行。 签署不允许代签。 修改单的签署与被修改的文档签署相同。 注：会签是撰拟公文的过程中，主办单位主动与有关单位协商并核签的一种办文程序，一般当公文的内容涉及本单位的多个部门或与其它单位有关时，需要进行会签。 * 6. 文档归档与保管 软件产品的文档是软件开发过程的真实记录,是重要的信息资源，因此必须实行集中统一管理，使之完善、安全并能有效地利用。 * (1) 文档归档 归档的文档应包括整个软件生存期内所形成的全部文档。文档归档应满足以下条件： 归档的文档应是经过鉴定或评审的 文档应签署完整、成套、格式统一、字迹工整 印制本、打印本以及各种报告应装订成册，并按规定进行编号，签署 软件文档应在开发过程每个阶段结束后及时归档 * (2) 文档保管 对一个单位来说，软件文档是极其重要的财富。 应在不同的地点建立设施来保存重要文档的副本。这种非现场的保存应储藏所有开发文档和产品文档的后备副本。如果文档是联机开发的，则应把它存储到磁带或磁盘上，以便能够迅速地将这些文档转换成可用的形式。在人为事故或自然灾害情况下，可以使用备用的磁带、磁盘、软盘、清单、系统图等重新构造系统。 文档保管包括登记、保存、借阅和修改等四项工作 文档保管应按国家和上级主管部门的要求，以及各单位的规章制度规定执行。 * 7. 文档维护 软件产品在投入运行后，往往还会有程序错误、文档错误以及适应新的环境和需求而要求增加或修改软件及其相关文档等情况。 因此，必须对软件产品及其文档进行维