开发文档范例
一.需求规格说明书
１。引言
１）编写目的：阐明保险需求说明书的目的,指明读者对象。
２）项目背景：包括 a 项目的委托单位、开发单位和主管部门。 b 该软件系统与其他系统的关系。
３）定义：列出文档中所用到的专业术语的定义和缩写的原文。
４）参考资料：包括 a 项目经核准的计划任务书、合同或上级机关的批文。b 项目开发计划。 c 文档所引用的资料、标准和规范。列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。
２。任务概述
１）目标。
２）运行环境。
３）条件与限制。
３。数据描述
１）静态数据。
２）动态数据。包括输入数据与输出数据。
３）数据库描述。给出使用数据库的名称和类型。
４）数据词典。
５）数据采集。
４。功能需求
１）功能划分。
２）功能描述。
５。性能需求
１）数据精确度。
２）时间特性。如响应时间、更新时间、数据转换与传输时间、运行时间等。
３）适应性。如操作方式、运行环境、与其他软件的接口以及开发计划等发生变化时、应具有的适应能力。
６。运行需求
１）用户界面。如屏幕格式、报表格式、彩单格式、输入输出时间等
２）硬件接口。
３）软件接口。
４）故障处理。
７。其他需求
如可使用性、安全保密、可维护性、可移植性等。
二、概要设计说明书
１。引言
１）编写目的：阐明保险需求说明书的目的,指明读者对象。
２）项目背景：包括 a 项目的委托单位、开发单位和主管部门。 b 该软件系统与其他系统的关系。
３）定义：列出文档中所用到的专业术语的定义和缩写的原意。
４）参考资料：列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。可包括 a 项目经核准的计划任务书、合同或上级机关的批文。b 项目开发计划。 c 需求规格说明书。d 测试计划（初稿）e 用户操作手册（初稿）。f 文档所引用的资料、采用的标准和规范。
２。任务概述
１）目标。
２）运行环境。
３）需求概述。
４）条件与限制。
３。总体设计
１）处理流程。
２）总体结构和模块外部设计。
３）功能分配。表明各项功能与程序结构的关系。
４。接口设计
１）外部接口。包括用户接口、软件接口与硬件接口。
２）内部接口。模块之间的接口。
５。数据结构设计
１）逻辑结构设计。
２）物理结构设计。
３）数据结构与程序的关系。
６。运行设计
１）运行模块的组合。
２）运行控制。
３）运行时间。
７。出错处理设计
１）出错输出信息。
２）出错处理对策。如设置任务、性能将级、恢复及再启动等。
８。安全保密设计
９。维护设计
应说明为方便维护工作的设施。如维护模块等。
三、详细设计说明书
１。引言
１）编写目的：阐明编写概要设计说明书的目的，指明读者对象。
２）项目背景：应包括项目的来源和主管部门等。
３）定义：列出文档中使用到的专门术语和缩写词的愿意。
４）参考资料：列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。可包括 a 项目经核准的计划任务书、合同或上级机关的批文。b 项目开发计划。 c 需求规格说明书。d 测试计划（初稿）e 用户操作手册（初稿）。f 文档所引用的资料、采用的标准和规范。
２。总体设计
１）需求概述
２）软件结构：如给出软件系统的结构图。
３。程序描述
逐个给出模块的以下说明：
１）功能。
２）性能。
３）输入项目。
４）输出项目。
５）算法：模块所选用的算法。
６）程序逻辑：详细描述模块实现的算法。可采用：a.标准流程图 b.PDL语言 c.N-S图 d.PAD e.判定表与描述算法的图表。
７）接口。
８）存储分配。
９）限制条件。
１０）测试要点：给出测试模块的主要测试要求。