软件开发设计文档模板

1、软件文档编写指南文档编号_版本号_文档名称：_工程名称：_工程负责人：_编写_ _ 年 月 日校对_ _ 年 月 日审核_ _ 年 月 日_ 年 月 日开发单位_系统规约说明书一. 引言A,文档的范围和目的B.概述1 .目标2.约束二. 功能和数据描述A.系统结构1 .结构关系图2.结构关系图描述三. 子系统描述A.子系统N的结构图规约说明B.结构字典C.结构连接图和说明四. 系统建模和模拟结构A.用于模拟的系统模型封面格式:System Specification)B.模拟结果C.特殊性能五. 软件工程问题A.软件工程可行性研究报告B.软件工程方案六. 附录软件工程可行性研究报告Report

2、 for Feasibility Study一. 引言1.编写目的说明编写可行性研究报告的目的，指出读者对象2.工程背景应包括：1所建议开发的软件名称；2工程的任务提出者、开发者、 用户及实现单位；3工程与其他软件或其他系统的关系。3.定义列出文档中用到的专门术语的定义和缩略词的原文。4.参考资料列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。二. 可行性研究的前提1 .要求列出并说明建议开发软件的根本要求，如1功能；2性能；3输出；4输入；5根本的数据流程和处理流程；6平安与保密要求；7与软件相关的其他系统；8完成期限。2.目标可包括：1人力与设备费用的节省；2处理速度的提高；

3、3控制精度和 生产能力的提高；4管理信息效劳的改良；5决策系统的改良；6人员工作效 率的提高，等等。3.条件、假定和限制可包括：1建议开发软件运行的最短寿命；2进行系统方案选择比拟的期限；3经费来源和使用限制；4法律和政策方面的限制；5硬件、 软件、运行环境和开发环境的条件和限制；6可利用的信息和资源；7建议开发软件投入使用的最迟时间。4.可行性研究方法5.决定可行性的主要因素三. 对现有系统的分析1.处理流程和数据流程2.工作负荷3.费用支出如人力、设备、空间、支持性效劳、材料等项开支。4.人员列出所需人员的专业技术类别和数量。5.设备6.局限性说明现有系统存在的问题以及为什么需要开发新的系

4、统。四. 所建议技术可行性分析1.对系统的简要描述2.处理流程和数据流程3.与现有系统比拟的优越性4.采用建议系统可能带来的影响1对设备的影响2对现有软件的影响3对用户的影响4对系统运行的影响5对开发环境的影响6对运行环境的影响7对经费支出的影响5.技术可行性评价包括：1在限制条件下，功能目标是否能够到达；2利用现有技术，功能目标能否到达；3对开发人员数量和质量的要求， 并说明能否满足；4在规定的期限内，开发能否完成。五. 所建议系统经济可行性分析1.指出1基建投资2其他一次性支出3经常性支出2.效益1一次性收益2经常性收益3不可定量收益3.收益/投资比4.投资回收周期5.敏感性分析指一些关键

5、性因素，如：系统生存周期长短、系统工作负荷量、处理速度要求、设备和软件配置变化对支出和效益的影响等的分析。六. 社会因素可行性分析1.法律因素如，合同责任、侵犯专利权、侵犯版权等问题的分析。2.用户使用可行性如，用户单位的行政管理、工作制度、人员素质等能否满足要求。七.其他可供选择的方案逐个说明其他可供选择的方案，并重点说明未被推荐的理由。八.结论意见可能是：1可着手组织开发；2需待假设干条件如资金、人力设备等具备后才能开发；3需对开发目标进行某些修改；4不能进行或不必进行 如技术不成熟，经济上不合算等；4其他。软件工程方案(Software Project Plan).引言1.编写目的说明编

6、写软件方案的目的，指出读者对象。2.工程背景 可包括：1工程委托单位、开发单位和主管部门；2该软件系统与其他系统的关系。3.定义列出本文档中用到的专门术语的定义和缩略词的原文。4.参考资料可包括：1工程经核准的方案任务书、合同或上级机关的批文；2文档所引用的资料、标准等；列出资料的作者、标题、编号、发表日期、出版单位或资 料来源。.工程概述1.工作内容简要说明工程的各项主要工作 ，介绍所开发软件的功能 性能等.假设不编写可 行性研究报告，那么应在本节给出较详细的介绍。2.条件与限制说明为完成工程应具备的条件开发单位已具备的条件以及尚需创造的条件.必要时还应说明用户及分合同承包者承当的工作完成期

7、限及其它条件与限制。3.产品1程序列出应交付的程序名称使用的语言及存储形式。2文档列出应交付的文档。3运行环境应包括硬件环境软件环境。4.效劳说明开发单位可向用户提供的效劳.如人员培训 安装 保修 维护和其他运行支持。5.验收标准三. 实施方案1.任务分解任务的划分及各项任务的负责人。2.进度按阶段完成的工程，用图表说明开始时间 完成时间。3.预算4.关键问题说明可能影响工程的关键问题，如设备条件 技术难点或其他风险因素，并说明对策。四. 人员组织及分工五. 交付期限六. 专题方案要点如测试方案质量保证方案配置管理方案人员培训方案系统安装方案 等。需求规格说明书(Requirements Sp

8、ecification)2.功能描述五.性能需求1.数据精确度2.时间特性如响应时间、更新处理时间、数据转化与传输时间、运行时间等。3.适应性在操作方式 运行环境 与其他软件的接口以及开发方案等发生变化时，应具 有的适应能力。六.运行需求1.用户界面如屏幕格式、报表格式、菜单格式、输入输出时间等。2.硬件接口3.软件接口4.故障处理七.其他需求如可使用性、平安保密、可维护性、可移植性等。 概要设计说明书(Architectural Design Specification)一.引言i编写目的说明编写概要设计说明书的目的，指明读者对象。2.工程背景可包括：1工程的委托单位，开发单位和主管部门；2

9、该软件系统与其 他系统的关系。3.定义列出文档中用到的专门术.引言1编写目的说明编写需求说明书的目的，指明读者对象。工程背景可包括：1工程的委托单位，开发单位和主管部门；2该软件系统与其 他系统的关系。定义列出文档中用到的专门术语定义和缩写词的原文。参考资料可包括：1工程经核准的方案任务书，合同或上机机关的批文；2工程 开发方案；3文档所引用的资料，标准和标准。列出这些资料的作者、 标题、编号、 发表日期、出版单位或资料来源。二. 任务概述1 .目标2.运行环境3.条件与限制三. 数据描述静态数据动态数据包括输入数据和输出数据。数据库描述给出使用数据库的名称和类型。数据词典数据采集2.341

10、.2345四.功能需求1.功能划分语定义和缩写词的原意。4.参考资料列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：1工程经核准的方案任务书，合同或上机机关的批文；2工程开发方案；3需求规格说明书；4测试方案初稿；5用户操作手册初稿；6文档 所引用的资料、采用的标准或标准。二.任务概述1 .目标2.运行环境3.需求概述4.条件与限制三.总体设计1 .处理流程2.总体结构和模块外部设计3.功能分配说明各项功能与程序结构的关系。四.接口设计1.外部接口包括用户界面软件接口与硬件接口。2.内部接口模块之间的接口。五.数据结构设计1 .逻辑结构设计2.物理结构设计3.数据结构与程

11、序的关系六.运行设计1.运行模块的组合2.运行控制3.运行时间七.出错处理设计1.出错输出信息2.出错处理对策如设置后备、性能降级、恢复及再启动等。八.平安保密设计九.维护设计说明为方便维护工作的设施， 如维护模块等。详细设计说明书(Procedural Design Specification)一.引言1.编写目的说明编写详细设计说明书的目的，指明读者对象。2.工程背景应包括工程的来源和主管部门等。3.定义列出文档中用到的专门术语定义和缩写词的原意。4.参考资料列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：1工程的方案任务书，合同或批文；2工程开发方案；3需求规格说明

12、书；3概要设计说明书；4测试方案初稿；5用户操作手册初稿；5文档所 引用的其他资料、软件开发标准或标准。二.总体设计1 .需求概述2.软件结构如给出软件系统的结果图。 三.程序描述逐个模块给出以下的说明：1 .功能2.性能3.输入工程4.输出工程5.算法模块所选用的算法。6.程序逻辑详细描述模块实现的算法， 可采用：1标准流程图；2 PDL语言；3N-S图；4 PAD ; 5判定表等描述算法的图表。7.接口8.存储分配9.限制条件10 .测试要点给出测试模块的主要测试要求。用户操作手册User Guide.引言1.编写目的说明编写手册的目的，指明读者对象。2.工程背景说明工程的来源、委托单位、

13、开发单位及主管部门。3.定义列出手册中用到的专门术语定义和缩写词的原意。4.参考资料列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可 包括：1工程的方案任务书，合同或批文；2工程开发方案；3需求规格说明书；4概要设计说明书；5详细设计说明书；6测试方案；7手册中引用的其他 资料、采用的软件工程标准或软件工程标准。二. 软件概述1 .目标2.功能3.性能1数据精确度包括输入、输出及处理数据的精度。2时间特性如响应时间、处理时间、数据传输时间等。3灵活性在操作方式、运行环境需做某些变更时软件的适应能力。三. 运行环境1.硬件列出软件系统运行时所需的硬件最小配置，如：1计算机型号、主

14、存容量；2外存储器、媒体、记录格式、设备型号及数量；3输入、输出设备；4数据传输设备及数据转换设备的型号及数量。2.支持软件如：1操作系统名称及版本号；2语言编译系统或汇编系统的名称及版本号；3数据库管理系统的名称及版本号；4其他必要的支持软件。四. 使用说明1.安装和初始化给出程序的存储形式、操作命令、反应信息及其含义、说明安装完成的测试实例以及安装所需的软件工具等。2.输入给出输入数据或参数的要求。1数据背景说明数据来源、存储媒体、出现频度、限制和质量管理等。2数据格式如：1长度2格式基准3标号4顺序5分隔符6词汇表7省略和重复8控制。3输入举例3.输出给出每项输出数据的说明。1数据背景说

15、明输出数据的去向、使用频度、存放媒体及质量管理等。2数据格式详细说明每一输出数据的格式，如:首部 主体和尾部的具体形式。3举例3.出错和恢复给出：1出错信息及其含义2用户应采取的措施，如修改、恢复、再启动。 4.求助查询说明如何操作。五. 运行说明1 .运行表列出每种可能的运行情况，说明其运行目的.2.运行步骤按顺序说明每种运行的步骤，应包括:1 运行控制2操作信息1运行目的2操作要求3启动方法4预计运行时间5操作命令格式及说明6其他事项。3输入/输出文件给出建立和更新文件的有关信息，如：1文件的名称及编 号2记录媒体3存留的目录4文件的支配说明确定保存文件或废弃 文件的准那么，分发文件的对象

16、，占用硬件的优先级及保密控制等。4启动或恢复过程六. 非常规过程提供给急或非常规操作的必要信息及操作步骤，系统切换操作以及维护人员须知的操作和考前须知。七. 操作命令一览表按字母顺序逐个列出全部操作命令的格式功能及参数说明。八. 程序文件或命令文件和数据文件一览表按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。九. 用户操作举例测试方案Test Plan一. 引言1.编写目的说明编写测试方案的目的，指明读者对象。如出错处理操作、向后备2.工程背景说明工程的来源委托单位及主管部门。3.定义 列出测试方案中用到的专门术语定义和缩写词的原意。4.参考资料列出这些资料的作者、标题

17、、编号、发表日期、出版单位或资料来源，可包括：1工程的方案任务书，合同或批文；2工程开发方案；3需求规格说明 书；3概要设计说明书；4详细设计说明书；5用户操作手册；g本测试方案中 引用的其他资料 采用的软件开发标准或标准。二. 任务概述1.目标2.运行环境3.需求概述4.条件与限制三. 方案1.测试方案说明确定测试方法和选取测试用例的原那么。2.测试工程列出组装测试和确认测试中每一项测试的内容、名称、目的和进度。3.测试准备4.测试机构及人员测试机构名称 负责人和职责。四.测试工程说明按顺序逐个对测试工程做出说明：1.测试工程名称及测试内容2.测试用例1输入输入的数据和输入的命令。2输出预期

18、的输出数据。3步骤及操作4允许偏差给出实测结果与预测结果之间允许偏差的范围。3.进度4.条件给出项测试对资源的特殊要求，如设备、软件、人员等。 5.测试资料说明项测试所需的资料。五. 评价1.范围说明所完成的各项测试说明问题的范围及其局限性。2.准那么说明评价测试结果的准那么。测试分析报告Test Specification一. 引言1.编写目的说明编写测试分析报告的目的，指明读者对象。2.工程背景 说明工程的来源、 委托单位及主管部门。3.定义列出测试分析报告中用到的专门术语定义和缩写词的原意。4.参考资料列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：1工程的方案任务

19、书，合同或批文；2工程开发方案；3需求规格说明书；4概要设计说明书；5详细设计说明书；6用户操作手册；7测试方案；8测试分析报告所引用的其他资料、采用的软件工程标准或软件工程标准。二. 测试方案执行情况1.测试工程列出每一测试工程的名称、内容和目的。 2.测试机构和人员给出测试机构名称、负责人和参与测试人员名单。3.测试结果按顺序给出每一测试工程的：1实测结果数据2与预期结果数据的偏差3该项测试说明的事实4该项测试发现的问题。三. 软件需求测试结论按顺序给出每一项需求测试的结论。包括：1证实的软件能力2局限性即项需求未得到充分测试的情况及原因。四. 评价1.软件能力经过测试所说明的软件能力。2

20、.缺陷和限制说明测试所揭露的软件缺陷和缺乏，以及可能给软件运行带来的影响。3.建议提出为弥补上述缺陷的建议。4.测试结论说明能否通过。开发进度月报一 .报告时间及所处的开发阶段二. 给出进度1 .本月内的主要活动2.实际进展与方案比拟三.所用工时按不同层次人员分别计时。 四.所有机时按所有计算机机型分别计时。五.经费支出分类列出本月经费支出工程， 给出支出总额，并与方案比拟。六. 工作遇到的问题及采取的对策七. 本月完成的成果八. 下月的工作方案九. 特殊问题工程开发总结报告一.引言1.编写目的说明编写总结报告的目的，指明读者对象。2.工程背景说明工程的来源、委托单位、开发单位及主管部门。 3.定义列出报告中用到的专门术语定义和缩写词的原意。4.参考资料列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：1工程的方案任务书，合同或批文；2工程开发方案；3需求规格说明书；4概要设计说明书；5详细设计说明书；6用户操作手册；7测试方案;8测试分析报告9本报告引用的其他资料、采用的开发标准或开发标准。-.开发结果1 .产品可包括：1列出各局部的程序名称、源程序行数包括注释行或目标程序字节数及程序总计数量、存储形式；产品文档名称等。2.主要功能及性能3.所用工时按人员的不同层次分别计时。4.所用机时按所用计算机机型分别计时。5.进度给出