软件工程文档模板范例Word下载.docx

1、编制数据要求说明书的内容要求如下：4.1引言4.1.1编写目的4.1.2背景4.1.3定义4.1.4参考资料4.2数据的逻辑描述4.2.1静态数据4.2.2动态输入数据4.2.3动态输出数据4.2.4内部生成数据4.2.5数据约定4.3数据的采集4.3.1要求和范围4.3.2输入的承担者4.3.3处理4.3.4影响5概要设计说明书概要设计说明书可称作系统设计说明书，这里说的系统是指程序系统，编制的目的是说明对程序的系统的设计考虑，包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。编制概要设计说明书的内

2、容要求如下：5.1引言5.1.1编写目的5.1.2背景5.1.3定义5.1.4参考资料5.2总体设计5.2.1需求规定5.2.2运行环境5.2.3基本设计概念和处理流程5.2.4结构5.2.5功能需求与程序的关系5.2.6人工处理过程5.2.7尚未解决的问题5.3接口设计5.3.1用户接口5.3.2内部接口5.3.3外部接口5.4运行设计5.4.1运行模块组合5.4.2运行控制5.4.3运行时间5.5系统数据结构设计5.5.1逻辑结构设计要点5.5.2物理结构设计要点5.5.3数据结构与程序的关系5.6系统出错处理设计5.6.1出错信息5.6.2补救措施5.6.3系统维护设计6详细设计说明书详

3、细说明书可称作程序设计说明书。编制目的是说明一个软件系统各个层次中的每一个程序（每个模块或子程序）的设计考虑，如果一个软件系统比较简单，层次很少，本文件可以不单独编写，有关内容合并概要设计说明书。对详细设计说明书的内容要不得要求如下：6.1引言6.1.1 编写目的6.1.2 背景6.1.3 定义6.1.4 参考资料6.2 程序系统的组织结构6.3 程序1（标识符）设计说明6.3.1 程序描述6.3.2 功能6.3.3 性能6.3.4 输入项6.3.5 输出项6.3.6 算法6.3.7 流程逻辑6.3.8 接口6.3.9 存储分配6.3.10 注释设计6.3.11 限制条件6.3.12 测试计划

4、6.3.13 尚未解决的问题6.4 程序2（标识符）设计说明三、需求规格说明书1引言1.1编写目的 为明确软件需求、安排项目规划与进度、组织软件开发与测试，撰写本文档。 本文档供项目经理、设计人员、开发人员参考。1.2项目背景a. 项目的委托单位、开发单位和主管部门b. 该软件系统与其他1.3定义【列出文当中所用到的专门术语的定义和缩写词的原文。】1.4参考资料 项目经核准的计划任务书、合同或上级机关的批文 项目开发计划c. 文档所引用的资料、标准和规范。列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源2任务概述2.1目标2.2运行环境操作系统：Microsoft Windows

5、2000 Advanced Server支持环境：IIS 5.0数 据 库：Microsoft SQL Server 20002.3条件与限制3数据描述3.1静态数据3.2动态数据【包括输入数据和输出数据。3.3数据库介绍【给出使用数据库的名称和类型。3.4数据词典3.5数据采集4功能需求4.1功能划分4.2功能描述5性能需求5.1数据精确度5.2时间特性【如响应时间、更新处理时间、数据转换与传输时间、运行时间等。5.3适应性【在操作方式、运行环境、与其它软件的接口以及开发计划等发生变化时，应具有的适应能力。6运行需求6.1用户界面【如屏幕格式、报表格式、菜单格式、输入输出时间等。6.2硬件接

6、口6.3软件接口6.4故障处理7其它需求【如可使用性、安全保密、可维护性、可移植性等。四、概要设计说明书【阐明编写概要设计说明书的目的，指明读者对象。【应包括： 项目的委托单位、开发单位和主管部门； 该软件系统与其他系统的关系。【列出本文档中所用到的专门术语的定义和缩写词的原文。【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括： 项目经核准的计划任务书、合同或上级机关的批文； 项目开发计划； 需求规格说明书；d. 测试计划（初稿）；e. 用户操作手册（初稿）；f. 文档所引用的资料、采用的标准或规范。2.3需求概述2.4条件与限制3总体设计3.1处理流程3.2总体结构和模

7、块外部设计3.3功能分配【表明各项功能与程序结构的关系。4接口设计 4.1外部接口【包括用户界面、软件接口与硬件接口。4.2内部接口【模块之间的接口。5数据结构设计5.1逻辑结构设计5.2物理结构设计5.3数据结构与程序的关系6运行设计6.1运行模块的组合6.2运行控制6.3运行时间7出错处理设计7.1出错输出信息7.2出错处理对策【如设置后备、性能降级、恢复及再启动等。8.安全保密设计9.维护设计【说明为方便维护工作的设施，如维护模块等。五、详细设计说明书【阐明编写详细设计说明书的目的，指明读者对象。【应包括项目的来源和主管部门等。【列出文档中所用到的专门术语的定义和缩写词的原文。项目的计划

8、任务书、合同或批文；项目开发计划；需求规格说明书；概要设计说明书；测试计划（初稿）；用户操作手册（初稿）；g.文档中所引用的其他资料、软件开发标准或规范。2总体设计2.1需求概述2.2软件结构【如给出软件系统的结构图。3程序描述【逐个模块给出以下的说明：3.1功能3.2性能3.3输入项目3.4输出项目3.5算法【模块所选用的算法。3.6程序逻辑【详细描述模块实现的算法，可采用：标准流程图；PDL语言；NS图；PAD；判定表等描述算法的图表。3.7接口3.8存储分配3.9限制条件3.10测试要点【给出测试模块的主要测试要求。六、用户操作手册【阐明编写手册的目的，指明读者对象。【应包括项目的来源、

9、委托单位、开发单位和主管部门。【列出手册中所用到的专门术语的定义和缩写词的原文。详细设计说明书；测试计划；手册中引用的其他资料、采用的软件工程标准或软件工程规范。2软件概述2.2功能2.3性能 数据精确度【包括输入、输出及处理数据的精度。 时间特性【如响应时间、处理时间、数据传输时间等。 灵活性【在操作方式、运行环境需做某些变更时软件的适应能力。3运行环境3.1硬件【列出软件系统运行时所需的硬件最小配置，如 计算机型号、主存容量； 外存储器、媒体、记录格式、设备型号及数量； 输入、输出设备； 数据传输设备及数据转换设备的型号及数量。3.2支持软件【如： 操作系统名称及版本号； 语言编译系统或汇

10、编系统的名称及版本号； 数据库管理系统的名称及版本号；其他必要的支持软件。4.使用说明4.1安装和初始化【给出程序的存储形式、操作命令、反馈信息及其含意、表明安装完成的测试实例以及安装所需的软件工具等。4.2输入【给出输入数据或参数的要求。4.2.1数据背景【说明数据来源、存储媒体、出现频度、限制和质量管理等。4.2.2数据格式长度；格式基准；标号；顺序；分隔符；词汇表；省略和重复；h.控制。4.2.3输入举例4.3输出【给出每项输出数据的说明。4.3.1数据背景【说明输出数据的去向、使用频度、存放媒体及质量管理等。4.3.2数据格式【详细阐明每一输出数据的格式，如：首部、主体和尾部的具体形式。4.3.3举例4.4出错和恢复【给出：出错信息及其含意；用户应采取的措施，如修改、恢复、再启动。4.5求助查询【说明如何操作。5.运行说明5.1运行表【列出每种可能的运行情况，说明其运行目的。5.2运行步骤【按顺序说明每种运行的步骤，应包括：5.2.1运行控制5.2.2操作信息