最新软件开发文档规范.doc

软件开发文档标准
附2:
软件文档编写向导
文档分类
工程包括如下几类文档：
工程管理文档。包括：?软件工程方案?、?工程进度报告?、?工程开发总结报告?
软件开发文档。包括：?需求规格说明?、?1．用户界面〔如屏幕格式、报表格式、菜单格式、输入输出时间等。〕
2．硬件接口
3．软件接口
4．故障处理
七．其他需求〔如可使用性、平安保密、可维护性、可移植性等。〕
概要设计说明书
〔Architectural Design Specification〕
 一．引言
1．编写目的〔说明编写概要设计说明书的目的，指明读者对象。〕
2．工程背景〔可包括：〔1〕工程的委托单位,开发单位和主管部门；〔2〕该软件系统与其他系统的关系。〕
3．定义〔列出文档中用到的专门术语定义和缩写词的原意。〕
4．参考资料〔列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：〔1〕工程开发方案；〔2〕需求规格说明书；〔3〕测试方案〔初稿〕；〔4〕用户操作手册〔初稿〕；〔5〕文档所引用的资料、采用的标准或标准。〕
二．任务概述
1．目标
2．运行环境
3．需求概述
4．条件与限制
三．总体设计
 1．处理流程
 2．总体结构和模块外部设计
 3．功能分配〔说明各项功能与程序结构的关系。〕
四．接口设计
1．外部接口〔包括用户界面软件接口与硬件接口。〕
2．内部接口〔模块之间的接口。〕
五．数据结构设计
1． 逻辑结构设计
2． 物理结构设计
3． 数据结构与程序的关系
六．运行设计
1．运行模块的组合
2．运行控制
3．运行时间
七．出错处理设计
1．出错输出信息
2．出错处理对策〔如设置后备、性能降级、恢复及再启动等。〕
八．平安保密设计
九．维护设计〔说明为方便维护工作的设施,如维护模块等。〕 
详细设计说明书
〔Procedural Design Specification〕
 一．引言
1． 编写目的〔说明编写详细设计说明书的目的,指明读者对象。〕
2． 工程背景〔应包括工程的来源和主管部门等。〕
3． 定义〔列出文档中用到的专门术语定义和缩写词的原意。〕
4． 参考资料〔列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：〔1〕工程开发方案；〔2〕需求规格说明书；〔3〕概要设计说明书；〔4〕测试方案(初稿)；〔5〕用户操作手册(初稿)；〔5〕文档所引用的其他资料、软件开发标准或标准。〕
二．总体设计
1．需求概述
2．软件结构〔如给出软件系统的结果图。〕
三．程序描述〔逐个模块给出以下的说明:：〕
1．功能
2．性能
3．输入工程
4．输出工程
5．算法〔模块所选用的算法。〕
6．程序逻辑〔详细描述模块实现的算法，可采用:：〔1〕标准流程图；〔2〕N-S图；〔3〕PAD；〔4〕判定表等描述算法的图表。〕
7．接口
8．存储分配
9．限制条件
10．测试要点〔给出测试模块的主要测试要求。〕
测试方案〔Test Plan〕 
一、引言
1． 编写目的〔说明编写测试方案的目的,指明读者对象。〕
2． 工程背景〔说明工程的来源委托单位及主管部门。〕
3． 定义〔列出测试方案中用到的专门术语定义和缩写词的原意。〕
4． 参考资料〔列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：〔1〕工程开发方案；〔2〕需求规格说明书；〔3〕概要设计说明书；〔4〕详细设计说明书；〔5〕用户操作手册; (6) 本测试方案中引用的其他资料采用的软件开发标准或标准。〕
二．任务概述
1．目标
2．运行环境
3．需求概述
4．条件与限制
三．方案
 1．测试方案〔说明确定测试方法和选取测试用例的原那么。〕
 2．测试工程〔列出组装测试和确认测试中每一项测试的内容、名称、目的和进度。〕
 3．测试准备
 4．测试机构及人员〔测试机构名称负责人和职责。〕
四．测试工程说明〔按顺序逐个对测试工程做出说明：〕
 1．测试工程名称及测试内容
 2．测试用例
〔1〕输入〔输入的数据和输入的命令。〕
〔2〕输出〔预期的输出数据。〕
 〔3〕步骤及操作
〔4〕允许偏差〔给出实测结果与预测结果之间允许偏差的范围。〕
3． 进度
4． 条件〔给出项测试对资源的特殊要求，如设备、软件、人员等。〕
5． 测试资料〔说明项测试所需的资料。〕
五．评价
1．范围〔说明所完成的各项测试说明问题的范