RSS
热门关键字:  计算机有关资料  33252  mkv  word  MKV_NT
当前位置 : 主页>vc编程>其它编程知识>列表

文档编写标准化

来源: 作者: 时间:2006-12-01 点击:

  7 物理结构设计

  8 数据结构与程序的关系

  9 运行设计

  9.1 运行模块的组合

  9.2 运行控制

  9.3 运行时间

  10 出错处理设计

  10.1 出错输出信息

  10.2 出错处理对策:如设置后备、性能降级、恢复及再启动等。

  11 安全保密设计

  12 维护设计

  说明为方便维护工作的设施,如维护模块等。

  详细设计说明书

  1 引言

  1.1 编写目的:阐明编写详细设计说明书的目的,指明读者对象。

  1.2 项目背景:应包括项目的来源和主管部门等。

  1.3 定义:列出本文档中所用到的专门术语的定义和缩写词的愿意。

  1.4 参考资料:

  ● 列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源

  ●项目经核准的计划任务书、合同或上级机关的批文;项目开发计划;需求规格说明书;概要设计说明书;测试计划(初稿);用户操作手册

  ● 文档所引用的资料、软件开发的标准或规范。

  2 总体设计

  2.1 需求概述

  2.2 软件结构:如给出软件系统的结构图。

  3 程序描述

  3.1 逐个模块给出以下说明:

  ● 功能

  ● 性能

  ● 输入项目

  ● 输出项目

  3.2 算法:模块所选用的算法。

  3.3 程序逻辑:详细描述模块实现的算法,可采用:标准流程图;PDL语言;N-S图;判定表等描述算法的图表。

  3.4 接口

  ● 存储分配

  ● 限制条件

  3.5测试要点:给出测试模块的主要测试要求。

  用户操作手册

  1 引言

  1.1 编写目的:阐明编写手册的目的,指明读者对象。

  1.2 项目背景:说明项目的来源、委托单位、开发单位及和主管部门。

  1.3 定义:列出手册中使用的专门术语的定义和缩写词的愿意。

  1.4 参考资料:

  ● 列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源

  ● 项目经核准的计划任务书、合同或上级机关的批文;项目开发计划;需求规格说明书;概要设计说明书;详细设计说明书;测试计划

  ● 文档中所引用的其他资料、采用的软件工程标准或软件工程规范。

  2 软件概述

  2.1 目标

  2.2 功能

  2.3 性能

  2.4 数据精确度:包括输入、输出及处理数据的精度。

  2.5 时间特性:如响应时间、处理时间、数据传输时间等。

  2.6 灵活性:在操作方式、运行环境需做某些变更时软件的适应能力。

  3 运行环境

  3.1 硬件

  ● 列出软件系统运行时所需的硬件最小配置,如计算机型号、主存容量

  ● 外存储器、媒体、记录格式、设备型号及数量

  ● 输入、输出设备

  ● 数据传输设备及数据转换设备的型号及数量。

  3.2 支持软件

  ● 操作系统名称及版本号

  ● 语言编译系统或汇编系统的名称及版本号

  ● 数据库管理系统的名称及版本号

  ● 其他必要的支持软件

  4 使用说明

  4.1 安装和初始化:给出程序的存储形式、操作命令、反馈信息及其做含意、表明安装完成的测试实例以及安装所需的软件工具等。

  4.2 输入:给出输入数据或参数的要求。

  ● 数据背景:说明数据来源、存储媒体、出现频度、限制和质量管理等。

  ● 数据格式:如长度、格式基准、标号、顺序、分隔符、词汇表、省略和重复、控制。

  ● 输入举例。

  4.3 输出:给出每项输出数据的说明。

  ● 数据背景:说明输出数据的去向、使用频度、存放媒体及质量管理等。

  ● 数据格式:详细阐明每一输出数据的格式,如首部、主体和尾部的具体形式。

  ● 举例

  4.4 出错和恢复:给出出错信息及其含意;用户应采取的措施,如修改、恢复、再启动。

  4.5 求助查询:说明如何操作。

  5 运行说明

  5.1 运行表:列出每种可能的运行情况,说明其运行目的。

  5.2 运行步骤:按顺序说明每和运行的步骤,应包括:

  5.3 运行控制

  5.4 操作信息:运行目的、运行目的、操作要求、启动方法、预计运行时间、操作命令格式及说明、其他事项;

  5.5输入/输出文件:给出建立或更新文件的有关信息,如:文件的名称及编号;记录媒体;存留的目录;文件的支配:说明确定保留文件或废弃文件的准则,分发文件的对象,战胜硬件的优先级及保密控制等。

  5.6 启动或恢复过程

  6 非常规过程

  提供应急戒非常规操作的必要信息及操作步骤,如出错处理操作、向后备系统切换操作及维护人员须知的操作和注意事项。

  7 操作命令一览表

  按字母顺序逐个列出全部操作命令的格式、功能及参数说明。

  8 程序文件(或命令文件)和数据文件一览表

  按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。

  9 用户操作举例

  测试计划

  1 引言

  1.1 编写目的:阐明编写测试计划的目的并指明读者对象。

  1.2 项目背景:说明项目的来源、委托单位及主管部门。

  1.3 定义:列出测试 计划中所用到的专门术语的定义和缩写词的原意。

  1.4参考资料:列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括:项目的计划任务书、合同或批文;项目开发计划;需求规格说明书;概要设计说明书;详细设计说明书;用户操作手册;本测试计划中引用的其他资料、采用

  的软件开发标准或规范。

  2 任务概述

  2.1 目标

  2.2 运行环境

  2.3 需求概述

  2.4 条件与限制

  3 计划

  3.1 测试方案:说明测试方法和选取测试用例的原则。

  3.2 测试项目:列出组装测试和确认测试中每一项测试的内容、名称、目的和进度。

  3.3 测试准备

  3.4 测试机构及人员:测试机构名称、负责人和职责。

  4 测试项目说明

  4.1 按顺序逐个对测试项目做出说明

  4.1.1 测试项目名称及测试内容

  4.1.2 测试用例

  4.1.3 输入:输入的数据和输入命令。

  4.1.4 输出:预期的输出数据。

  4.2 步骤及操作

  4.3 允许偏差:给出实测结果与预期结果之间允许偏差的范围。

  4.4 进度

  4.5 条件:给出项测试对资源的特殊要求,如设备、软件、人员等。

  4.6 测试资料:说明项测试所需的资料。

  5 评价

  5.1 范围:说明所完成的各项测试说明问题的范围及其局限性。

  5.2 准则:说明评论测试结果的准则。

  测试分析报告

  1 引言

  1.1 编写目的:阐明编写测试分析报告的目的并指明读者对象。

  1.2 项目背景:说明项目的来源、委托单位及主管部门。

  1.3定义:列出测试分析报告中所用到的专门术语的定义和缩写词的原意。

  1.4参考资料:列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括:项目的计划任务书、合同或批文;项目开发计划;需求规格说明书;概要设计说明书;详细设计说明书;用户操作手册;测试计划;测试分析报告所引用的其他资料、采用的软件工程标准或工程规范。

共3页: 上一页 [1] 2 [3] 下一页
最新评论共有 0 位网友发表了评论
发表评论
评论内容:不能超过250字,需审核,请自觉遵守互联网相关政策法规。
用户名: 密码:
匿名?
注册