GB T 16680 1996 软件文档管理指南2 L

 

9.6  文档归档与保管

    软件产品的文档是软件开发过程的真实记录，是重要的信息资源，因此必须实行集中统一管理，使

  之完善、安全并能有效地利用．

9．6．1  文档归档

    归档的文档应包括整个软件生存期内所形成的全部文档．

    文档归档应满足以下条件。

    a)归档的文档应是经过鉴定或评审的，

    b)文档应签署完整、成套、格式统一、字迹工整

    c)印制本、打印本以及各种报告应装订成册，并按规定进行编号，签署。

    软件文档应在开发过程每个阶段结束后及时归档。

9．6．2  文档保管

    对一个单位来说，软件文档是极其重要的财富．它代表一种在时间、思想和能力上的具有特殊意义

  的投资．此外，软件文档描述另一方面的重要投资——开发工作和产品t

    应在不同的地点建立设施来保存重要文档的副本．这种非现场的保存应储藏所有开发文档和产品

文档的后备副本．如果文档是联机开发的，则应把它存储到磁带或磁盘上，以便能够迅速地将这些文档

转换成可用的形式． 

    在人为事故或自然灾害情况下，可以使用备用的磁带、磁盘、软盘、清单、系统图等重新构造系统．

    文档保管包括登记、保存、借阅和修改等四项工作．

    文档保管应按国家和上级主管部门的要求，以及各单位的规章制度规定执行-

9.7  文档维护

    软件产品在投入运行后，往往还会有程序错误、文档错误以及适应新的环境和需求而要求增加或修

改软件及其相关文档等情况．因此，必须对软件产品及其文档进行维护，其过程大致可分以下几步

    a)软件产品完成后，确定软件维护人员J

    b)在软件的运行过程中，由软件维护人员负责收集、记录从用户或其他途径反馈回来的软件质

量信息

    o)在分析整理后，按OB 8666---88中附录A填写_软件问题报告，

    d)  由软件维护人员或该项目的课题组人员根据F软件问题报告彦中提出的要求，填写一软件修申请报告彦，

    e)根据批准后的“软件修改申请报告一，由该项目的课题组人员或软件维护人员对程序进行修改

和测试

    f)在测试通过后，由程序修改人员按OB 8666"--88中附录B填写F软件修改报告一，并修改相应的

文档和媒体，

    g)将_软件修改报告彦和修改后的文档送审核、会签、标准化、批准等有关负责人审阅、签署，

    h)将修改后的文档、媒体和一软件修改报告一送档案管理部门存档，

I)软件维护人员汇总并整理修改的情况，在此基础上编写_软件维护通报一．

10所需资源

 为了编制高质量文档，必须得到必要的资源．所需的资源包括。

    a)人员，

    b)设备，

    c)资金．

10.1  人员

    技术工作和技术管理主要取决于人。没有任何指南、标准或方法（学）能够代替技术素质高的人．技

术写作和文档技术方面的某些培训是必要的，也是有用的．但是，放在首位的仍然是任用既胜任计算机

程序开发、又胜任文档工作的人员。

10.2  设备

    某些自动的软件工具已成功地应用于开发文档的编制工作．计算机程序能够提供图表、索引、数据

元素表以及子程序和其他程序成分之间的交叉引用。这些可避免令人乏味地重复录入草案材料，并且容

许自动地重新打印更新后的文档．

    用于检查文档的一致性及在需求、设计文档和计算机代码之间提供相关性的计算机技术也已经开发成功．

    如果自动辅助工具的成本和附加资源相对于整个项目资源来说是合理的，则应加以使用．

10.3  资金

    虽然开发文档的费用很少作为单独的预算项目，且产品文档的费用常常估计过低，但实际上开发文

档和产品文档的费用却占开发费用中的很大一部分．

    支持文档编写人员，他们使用的设备，以及文档的保存、复制、分发和维护都需要资金，评审和更新需要花时间和人力．项目预算和计划表必须反映这些费用．

在制定计划过程中应请文档专家和通晓文档工作的人协助确定合理的预算．

附录A

（提示的附录）

文档策略检查表

 

    文档策略检查表如下

    一适当的文档的决策作出了吗？

    一涉及文档的策略声明发布了吗？

    一负责开发文档和产品文档编写工作的人员或部门落实了吗？

    一用于文档编制的资源落实了吗？

    一负责文档质量的人员或部门落实了吗？

    一各管理层次和组织各分支（诸如软件工程、硬件工程、系统工程、质量保证和文档编制等）之间

  的各种关系确定了吗？对于文档的编制、分发和维护等方面是否确定了职责、所需活动和联系途径？

   —所有的文档要求已列入整个项目开发计划表中了吗？

    一适用的文档标准已确定了吗？

一是否已考虑采用支持工具和自动化的文档编制？

  附录B

（提示的附录）

文档计划检查表

    文档计划检查表如下．

    一文档计划编制好了吗？

    一所需的文档类型确定好了吗？

    一所需的内容是否已列提纲并描述了？

    一文档标准确定了吗？

    一文档标准制订好了吗？

    一有关文档编制、文档管理员、备用的文档存储及文档评审的职责分配好了吗？

    一质量准则建立了吗7

    —有关提交草稿概要、初稿、修订稿、图示的计划表是杏已建立？

    一评审日期确定了吗？

    一一个认可的周期确立了吗？

一制作方法是否已选定并作出计划了？

    附录C

  （提示的附录）

文档管理规程检查表

    文档管理规程检查表如下

    一评审规程建立了吗？

    一分析员、开发人员、程序员、维护人员、评审员、用户及管理员的参与合作考虑了没有？

    一一个认可的周期确定了吗？

    一为每个文档或文档类型建立分配表了吗？

    一使文档内容保持最新的方法确定了吗？

    一用于获取用户对文档的建议和反应的反馈机制建立了吗？

    —有关保管和分发的维护规程建立了吗？

    一有关文档的标识和管理的规程建立了吗？

    一保存重要文档用的设施建立了吗？

     附录D

    （提示的附录）

软件文档编制时间

 

软件文档编制的时间见表D1．

表D1

序号	阶段  文档名称	可行性研  究阶段	开发阶段						运行与维   护阶段
			需求分析	概要设计	详细设计	实现	测试	试运行
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 18 19 20 21 22 23 24 26 27 29 30 31 32 33 34 35 37 38 39 40 41	任务委托书 可行性研究报告 软件需求说明书 数据要求说明书 软件需求评审报告 项目任务书 项目开发计划 概要设计说明书 程序流程图 软件分析报告 数据库设计说明书 详细设计说明书 测试计划 模块开发卷宗 详细设计评审报告 程序 测试分析报告 用户手册 操作手册 程序维护手册 开发进度月报 项目开发总结报告 用户使用报告 产品标准 媒体程序图 成套软件明细表 整件明细表 成套运用文档清单 经济分析报告 标准化审查报告 性能测试报告 资料审查报告 鉴定会纪要 软件验收报告 软件问题报告 软件修改报告 软件维护通报	→
		○
			○ →
				○
					○
								○ ○ ○ ○

注：“○”表示在软件开发过程某阶段结束时进行评审活动，并编制相应报告．

附录E

  （提示的附录）

各评审点评审内容

 

软件开发过程各评审点评审内容见表E1。

表E1

  附录F

（提示的附录）

软件文档签署者

软件文档的签署者见表F1。

表F1

序号	文件名称	拟制	审核	会签	标准化	批准
1	任务委托书	课题组成员	技术管理部门			委托单位领导
2	可行性研究报告	主管设计师	主任设计师		标准化主管师	总设计师
3	可行性评审报告	评审组				评审组组长
4	软件需求说明书	主管设计师	主任设计师	质管部	标准化主管师	总设计师
5	数据要求说明书	主管设计师	主任设计师		标准化主管师	总设计师
6	软件需求评审报告	评审组				评审组组长
7	项目任务书	主管设计师	主任设计师	科技部	标准化主管师	总设计师
8	项目开发计划	主管设计师	主任设计师	科技部	标准化主管师	总设计师
9	质量保证计划	主管设计师	主任设计师	质管部	标准化主管师	总设计师
lO	配置管理计划	主管设计师	主任设计师		标准化主管师	总设计师
ll	概要设计说明书	设计师	主管设计师		标准化主管师	主任设计师
12	程序流程图	设计师	主管设计师		标准化主管师	主任设计师
13	软件分析报告	设计师	主管设计师		标准化主管师	主任设计师
14	数据库设计说明书	设计师	主管设计师		标准化主管师	主任设计师
15	概要设计评审报告	评审组				评审组组长
16	详细设计说明书	设计师	主管设计师		标准化主管师	主任设计师
17	测试计划	设计师	主管设计师		标准化主管师	主任设计师
18	模块开发卷宗	设计师	主管设计师		标准化主管师	主任设计师
19	详细设计评审报告	评审组				评审组组长
20	程序	设计师	主管设计师		标准化主管师	主任设计师
2l	测试分析报告	设计师	主管设计师		标准化主管师	主任设计师
22	用户手册	主管设计师	主任设计师	质管部	标准化主管师	总设计师
23	操作手册	主管设计师	主任设计师		标准化主管师	总设计师
24	程序维护手册	主管设计师	主任设计师		标准化主管师	总设计师
25	安装实施手册	主管设计师	主任设计师		标准化主管师	总设计师
26	开发进度月报	主管设计师	主任设计师	科技部	标准化主管师	总设计师
27	项目开发总结报告	主管设计师	主任设计师		标准化主管师	总设计师
28	用户使用报告	用户单位				用户单位负责人
29	产品标准	主管设计师	主任设计师		标准化主管师	总设计师

 

 

序号	文件名称	拟制	审核	会签	标准化	批准
30	媒体内容分布图	设计师	主管设计师		标准化主管师	主任设计师
31	成套软件明细表	设计师	主管设计师		标准化主管师	主任设计师
32	成套运用软件清单	设计师	主管设计师		标准化主管师	主任设计师
33	经济分析报告	财务人员		总设计师		财务部门负责人
34	标准化审查报告	标准化主管师				标准化室主任
35	性能测试报告					测试组组长
36	资料审查报告					审查组组长
37	鉴定会纪要					鉴定委员会主任
38	软件验收报告					验收委员会主任
39	软件问题报告	维护人员				总设计师
40	软件修改报告	主管设计师	主任设计师		标准化主管师	总设计师
41	软件维护通报	主管设计师	主任设计师		标准化主管师	总设计师
注：表中签署栏是对设计师系统而言．对于其他系统可由相应的人员签署．例如I对工厂企业来说．“设计师”           相应为“拟制人员”，“主管设计师”相应为“产品负责人”，“主任设计师”相应为。“研制部门负责人”，      总设计师”相应为“企业负责人”或“企业技术负责人”．

324