文档分为四个层次

文档分为四个层次,第1张

《软件文档管理指南》(GB/T 16680-1996中明确指出了如何确定文档的质量等级,内容如下:

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

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

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

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

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

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

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

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

例题1 根据GB/T16680-1996 《软件文档管理指南》的规定,文档也是要分质量等级的。适合于同一个单位内若干人联合开发的程序,或可被其他单位使用的程序的文档被称为()。

A.最低限度文档

B.内部文档

C.工作文档

D.正式文档

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

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

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

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

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

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

按照以下格式填就好了,不过是我自己写的,有不好的地方大家互相学习修改一下~

详细设计文档规范

1.0概述

这部分提供对整个设计文档的概述。描述了所有数据,结构,接口和软件构件级别的设计。

1.1 目标和对象

描述软件对象的所有目标。

1.2 陈述范围

软件描述。主要输入,过程功能,输出的描述,不考虑详细细节。

1.3 软件内容

软件被置于商业或者产品线中,讨论相关的战略问题。目的是让读者能够对“宏图”有所了解。

1.4 主要系统参数

任何商务软件或者产品线都包含软件规定、设计、实现和测试的说明和规范。

2.0 数据设计

描述所有数据结构包括内部变量,全局变量和临时数据结构。

2.1 内部软件数据结构

描述软件内部的构件之间的数据传输的结构。

2.2 全局数据结构

描述主要部分的数据结构。

2.3 临时数据结构

为临时应用而生成的文件的描述。

2.4 数据库描述

作为应用程序的一部分,描述数据库结构。

3.0 结构化和构件级别设计

描述程序结构。

3.1 程序结构

详细描述应用程序所选定的程序结构。

3.1.1 结构图

图形化描述结构。

3.1.2 选择性

讨论其它可供考虑的结构。选定3.1.1中结构类型的原因。

3.2 构件描述

详细描述结构中的每个软件构件。

3.2.1 构件过程叙述(PSPEC)

描述构件的过程。

3.2.2 构件接口描述

详细描述构件的输入和输出。

3.2.3 构件执行细节

每个构件的详细演算描述。

3.2.3.1 接口描述

3.2.3.2 演算模型(e.g., PDL)

3.2.3.3 规范/限制

]3.2.3.4 本地数据结构

3.2.3.5 在3.2.3.6设计中包含的执行结果

3.3 软件接口描述

软件对外界的接口描述

3.3.1机器对外接口

与其他机器或者设备的接口描述。

3.3.2系统对外接口

对其它系统、产品和网络的接口描述。

3.3.3与人的接口

概述软件与任何人的界面。

4.0 用户界面设计

描述软件的用户界面设计。

4.1 描述用户界面

详细描述用户界面,包括屏幕显示图标、图片或者类型。

4.1.1 屏幕图片

从用户角度描述界面。

4.1.2 对象和 *** 作

所有屏幕对象和 *** 作的定义。

4.2 界面设计规范

用户界面的设计和实现的规范和标准。

4.3 可见构件

实现的GUI可见构件说明。

4.4 UIDS描述

用户界面开发系统描述。

5.0约束、限制和系统参数

会影响软件的规格说明、设计和实现的特殊事件。

6.0测试标准

测试策略和预备测试用例描述。

6.1 测试的类别

规定实施测试的类别,包括尽量详细的描述。这里是针对黑盒测试现象的描述。

6.2期待软件反馈

测试期待的结果描述。

6.3执行界线

特殊执行需要的说明。

6.4 重要构件确认

决定性构件或者需要特殊注意的构件的测试确认。

7.0附录

设计说明的补充信息。

7.1系统可跟踪矩阵

一个定期回归系统规格跟踪软件需求的矩阵。

7.2 产品战略

如果规格说明书是为一个产品设计的,描述相关的产品战略。

7.3 使用分析算法

描述所有分析活动所使用到的分析算法。

7.4 补充信息 (如果有需要特别说明的)


欢迎分享,转载请注明来源:内存溢出

原文地址: http://outofmemory.cn/yw/12137073.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2023-05-21
下一篇 2023-05-21

发表评论

登录后才能评论

评论列表(0条)

保存