您的位置:那一世范文网 > 心得体会 > 经验交流 > 正文

计算机文档管理标准[规范]

经验交流范文 发布时间:2013/3/16

计算机文档管理标准[规范]第2页

——他们在计算机系统上运行软件;

——维护人员 ——他们维护、增强或变更软件。

产品文档包括如下内容:

——用于管理者的指南和资料,他们监督软件的使用;

——宣传资料 通告软件产品的可用性并详细说明它的功能、运行环境等;

——一般信息 对任何有兴趣的人描述软件产品。

基本的产品文档包括:

——培训手册;

——参考手册和用户指南;

——软件支持手册;

——产品手册和信息广告。

7.2.3 管理文档

这种文档建立在项目管理信息的基础上,诸如:

——开发过程的每个阶段的进度和进度变更的记录;

——软件变更情况的记录;

——相对于开发的判定记录;

——职责定义。

这种文档从管理的角度规定涉及软件生存的信息。

相关文档的详细规定和编写格式见gb 8567。

7.3 确定文档的质量等级

仅仅依据规章、传统的做法或合同的要求去制作文档是不够的。管理者还必须确定文档的质量要求以及如何达到和保证质量要求。

质量要求的确定取决于可得到的资源、项目的大小和风险,可以对该产品的每个文档的格式及详细程度作出明确的规定。

每个文档的质量必须在文档计划期间就有明确的规定。文档的质量可以按文档的形式和列出的要坟划分为四级。

最低限度文档(1级文档) 1级文档适合开发工作量低于一个人月的开发者自用程序。该文档应包含程序清单、开发记录、测试数据和程序简介。

内部文档(2级文档) 2级文档可用于在精心研究后被认为似乎没有与其他用户共享资源的专用程序。除1级文档提供的信息外,2级文档还包括程序清单内足够的注释以帮助用户安装和使用程序。

工作文档(3级文档) 3级文档适合于由同一单位内若干人联合开发的程序,或可被其他单位使用的程序。

正式文档(4级文档) 4级文档适合那些要正式发行供普遍使用的软件产品。关键性程序或具有重复管理应用性质(如工资计算)的程序需要4级文档。4级文档遵守gb 8567的有关规定。

质量方面需要考虑的问题即要包含文档的结构,也要包含文档的内容。文档内容可以根据正确性、完整性和明确性来判断。而文档结构由各个组成部分的顺序和总体安排的简单性来测定。要达到这四个质量等级,需要的投入和资源逐级增加,质量保证机构必须处于适当的行政地位以保证达到期望的质量等级。

8 文档编制计划

文档计划可以是整个项目计划的一部分或是一个独立的文档。应该编写文档计划并把它分发给全体开发组成员,作为文档重要性的具体依据和管理部门文档工作责任的备忘录。

对于小的、非正式的项目,文档计划可能只有一页纸;对于较大的项目,文档计划可能是一个综合性的正式文档,这样的文档计划应遵循各项严格的标准及正规的评审和批准过程。

编制计划的工作应及早开始,对计划的评审应贯穿项目的全过程。如同任何别的计划一样,文档计划指出未来的各项活动,当需要修改时必须加以修改。导致对计划作适当修改的常规评审应作为该项目工作的一部分,所有与该计划有关的人员都应得到文档计划。

文档计划一般包括以下几方面内容:

a) 列出应编制文档的目录;

b) 提示编制文档应参考的标准;

c) 指定文档管理员;

d) 提供编制文档所需要的条件,落实文档编写人员、所需经费以及编制工具等;

e) 明确保证文档质量的方法,为了确保文档内容的正确性、合理性,应采取一定的措施,如评审、鉴定等等;

f) 绘制进度表,以图表形式列出在软件生存期各阶段应产生的文档、编制人员、编制日期、完成日期、评审日期等。

附录b中的检查表为制定一个文档计划或评估现有文档计划的完整性提供帮助。

此外,文档计划规定每个文档要达到的质量等级,以及为了达到期望的结果必须考虑哪些外部因素。

文档计划还确定该计划和文档的分发,并且明确叙述与文档工作的所有人员的职责。


计算机文档管理标准[规范]》由那一世范文网整理分享,版权归原作者所有,转载引用请注明网址出处。
Copyright © 2010-2018 www.nayishi.com 那一世范文网 All Rights Reserved.