软件开发文档编写指南 .docx

《软件开发文档编写指南 .docx》由会员分享，可在线阅读，更多相关《软件开发文档编写指南 .docx（16页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、精品名师归纳总结软件文档编写指南目 录封面格式：2系统规约说明书 System Specification3软件项目可行性讨论报告 Report for Feasibility Study4软件项目方案 Software Project Plan6需求规格说明书 Requirements Specification7概要设计说明书 Architectural Design Specification8具体设计说明书 Procedural Design Specification9用户操作手册 User Guide10测试方案 Test Plan12测试分析报告 Test Specificati

2、on13开发进度月报14项目开发总结报告15软件修改报告16可编辑资料 - - - 欢迎下载精品名师归纳总结封面格式：文档编号版本 号文档名称：项目名称： 项目负责人：编写年月日校对年月日审核年月日批准年月日开发单位可编辑资料 - - - 欢迎下载精品名师归纳总结系统规约说明书 System Specification一引言A. 文档的范畴和目的B. 概述1目标2约束二功能和数据描述A.系统结构 1结构关系图 2结构关系图描述三子系统描述A. 子系统 N 的结构图规约说明B. 结构字典C. 结构连接图和说明四系统建模和模拟结构A. 用于模拟的系统模型B. 模拟结果C. 特别性能五软件项目问题A

3、. 软件项目可行性讨论报告B. 软件项目方案六附录可编辑资料 - - - 欢迎下载精品名师归纳总结软件项目可行性讨论报告Report for Feasibility Study一引言1. 编写目的阐明编写可行性讨论报告的目的，指出读者对象2. 项目背景应包括： 1所建议开发的软件名称。 2项目的任务提出者、开发者、用户及实现单位。 3项目与其他软件或其他系统的关系。3. 定义列出文档中用到的特的术语的定义和缩略词的原文。4. 参考资料列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。二可行性讨论的前提1. 要求列出并说明建议开发软件的基本要求，如1功能。2性能。3输出。4输入。5基

4、本的数据流程和处理流程。 6安全与保密要求。 7与软件相关的其他系统。 8完成期限。 2. 目标可包括： 1人力与设备费用的节约。 2处理速度的提高。 3掌握精度和生产才能的提高。 4治理信息服务的改良。 5决策系统的改良。 6人职工作效率的提高，等等。 3. 条件、假定和限制可包括： 1建议开发软件运行的最短寿命。 2进行系统方案 挑选比较的期限。 3经费来源和使用限制。 4法律和政策方面的限制。5硬件、软件、运行环境和开发环境的条件和限制。6可利用的信息和资源。 7建议开发软件投入使用的最迟时间。4. 可行性讨论方法5. 打算可行性的主要因素三对现有系统的分析1. 处理流程和数据流程2.

5、工作负荷3. 费用支出如人力、设备、空间、支持性服务、材料等项开支。4. 人员列出所需人员的专业技术类别和数量。5. 设备6. 局限性说明现有系统存在的问题以及为什么需要开发新的系统。四所建议技术可行性分析1. 对系统的简要描述2. 处理流程和数据流程3. 与现有系统比较的优越性4. 采纳建议系统可能带来的影响1对设备的影响2对现有软件的影响3对用户的影响4对系统运行的影响5对开发环境的影响6对运行环境的影响7对经费支出的影响5. 技术可行性评判包括： 1在限制条件下，功能目标是否能够到达。2利用现有可编辑资料 - - - 欢迎下载精品名师归纳总结技术，功能目标能否到达。 3对开发人员数量和质

6、量的要求，并说明能否满意。4在规定的期限内，开发能否完成。五所建议系统经济可行性分析1. 指出1基建投资2其他一次性支出3常常性支出2. 效益1一次性收益2常常性收益3不行定量收益3. 收益 /投资比4. 投资回收周期5. 敏锐性分析指一些关键性因素，如：系统生存周期长短、系统工作负荷量、处理速度要求、设备和软件配置变化对支出和效益的影响等的分析。六社会因素可行性分析1. 法律因素如，合同责任、侵害专利权、侵害版权等问题的分析。2. 用户使用可行性如，用户单位的行政治理、工作制度、人员素养等能否满意要求。七其他可供挑选的方案逐个阐明其他可供挑选的方案，并重点说明未被举荐的理由。八结论看法可能是

7、： 1可着手组织开发。 2需待假设干条件如资金、人力设备等具备后才能开发。 3需对开发目标进行某些修改。 4不能进行或不必进行如技术不成熟，经济上不合算等 。4其他。可编辑资料 - - - 欢迎下载精品名师归纳总结软件项目方案 Software Project Plan一引言1. 编写目的阐明编写软件方案的目的，指出读者对象。2. 项目背景可包括： 1项目托付单位、开发单位和主管部门。2该软件系统与其他系统的关系。 3. 定义列出本文档中用到的特的术语的定义和缩略词的原文。4. 参考资料可包括： 1项目经核准的方案任务书、合同或上级机关的批文。2文档所引用的资料、标准等。列出资料的作者、标题、

8、编号、发表日期、出版单位或资料来源。二项目概述1. 工作内容简要说明项目的各项主要工作,介绍所开发软件的功能性能等 .假设不编写可行性讨论报告 ,就应在本节给出较具体的介绍。2. 条件与限制阐明为完成项目应具备的条件开发单位已具备的条件以及尚需制造的条 件.必要时仍应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。 3. 产品1程序列出应交付的程序名称使用的语言及储备形式。 2文档列出应交付的文档。 3运行环境应包括硬件环境软件环境。4. 服务阐明开发单位可向用户供应的服务.如人员培训安装 保修保护和其他运行支持。5. 验收标准三实施方案1. 任务分解任务的划分及各项任务的负责人。2

9、. 进度按阶段完成的项目,用图表说明开头时间完成时间。3. 预算4. 关键问题说明可能影响项目的关键问题,如设备条件技术难点或其他风险因素,并说明计策。四人员组织及分工五交付期限六专题方案要点如测试方案质量保证方案配置治理方案人员培训方案系统安装方案等。可编辑资料 - - - 欢迎下载精品名师归纳总结需求规格说明书 Requirements Specification一引言1. 编写目的阐明编写需求说明书的目的,指明读者对象。 2. 项目背景可包括： 1项目的托付单位,开发单位和主管部门。 2该软件系统与其他系统的关系。 3. 定义列出文档中用到的特的术语定义和缩写词的原文。4. 参考资料可包

10、括： 1项目经核准的方案任务书,合同或上机机关的批文。 2项目开发方案。 3文档所引用的资料，标准和标准。列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。二任务概述1. 目标2. 运行环境3. 条件与限制三数据描述1. 静态数据2. 动态数据包括输入数据和输出数据。3. 数据库描述给出访用数据库的名称和类型。4. 数据词典5. 数据采集四功能需求1. 功能划分2. 功能描述五性能需求1. 数据精确度2. 时间特性如响应时间、更新处理时间、数据转化与传输时间、运行时间等。3. 适应性在操作方式运行环境与其他软件的接口以及开发方案等发生变化时，应具有的适应才能。 六运行需求1. 用户

11、界面如屏幕格式、报表格式、菜单格式、输入输出时间等。2. 硬件接口3. 软件接口4. 故障处理七其他需求如可使用性、安全保密、可保护性、可移植性等。可编辑资料 - - - 欢迎下载精品名师归纳总结概要设计说明书 Architectural Design Specification一引言1. 编写目的阐明编写概要设计说明书的目的，指明读者对象。2. 项目背景可包括： 1项目的托付单位,开发单位和主管部门。 2该软件系统与其他系统的关系。 3. 定义列出文档中用到的特的术语定义和缩写词的原意。4. 参考资料列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：1项目经核准的方案任务

12、书，合同或上机机关的批文。2项目开发方案。3需求规格说明书。 4测试方案初稿 。5用户操作手册初稿 。6文档所引用的资料、采纳的标准或标准。二任务概述1. 目标2. 运行环境3. 需求概述4. 条件与限制三总体设计1. 处理流程2. 总体结构和模块外部设计3. 功能安排说明各项功能与程序结构的关系。四接口设计1. 外部接口包括用户界面软件接口与硬件接口。 2. 内部接口模块之间的接口。 五数据结构设计1. 规律结构设计2. 物理结构设计3. 数据结构与程序的关系六运行设计1. 运行模块的组合2. 运行掌握3. 运行时间 七出错处理设计1. 出错输出信息2. 出错处理计策如设置后备、性能降级、复

13、原及再启动等。八安全保密设计九保护设计说明为便利保护工作的设施,如保护模块等。 可编辑资料 - - - 欢迎下载精品名师归纳总结具体设计说明书 Procedural Design Specification一引言1. 编写目的阐明编写具体设计说明书的目的,指明读者对象。 2. 项目背景应包括项目的来源和主管部门等。3. 定义列出文档中用到的特的术语定义和缩写词的原意。4. 参考资料列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：1项目的方案任务书 ,合同或批文。 2项目开发方案。 3需求规格说明书。3概要设计说明书。 4测试方案 初稿 。5用户操作手册 初稿 。5文档所引

14、用的其他资料、软件开发标准或标准。二总体设计1. 需求概述2. 软件结构如给出软件系统的结果图。三程序描述逐个模块给出以下的说明:：1. 功能2. 性能3. 输入项目4. 输出项目5. 算法模块所选用的算法。 6. 程序规律具体描述模块实现的算法，可采纳:：1标准流程图。 2PDL 语言。3 N-S 图。4PAD。5判定表等描述算法的图表。 7. 接口8. 储备安排9. 限制条件10. 测试要点给出测试模块的主要测试要求。可编辑资料 - - - 欢迎下载精品名师归纳总结用户操作手册 User Guide 一引言1. 编写目的阐明编写手册的目的，指明读者对象。2. 项目背景说明项目的来源、托付单

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

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

17、输出给出每项输出数据的说明。1数据背景说明输出数据的去向、使用频度、存放媒体及质量治理等。2数据格式具体阐明每一输出数据的格式,如: 首部主体和尾部的具体形式。 3举例3. 出错和复原给出： 1出错信息及其含义 2用户应实行的措施，如修改、复原、再启动。4. 求助查询说明如何操作。 五运行说明1. 运行表列出每种可能的运行情形,说明其运行目的 .2. 运行步骤按次序说明每种运行的步骤,应包括 :可编辑资料 - - - 欢迎下载精品名师归纳总结1 运行掌握2 操作信息 1运行目的 2操作要求 3启动方法 4估量运行时间 5操作命令格式及说明 6其他事项。 3 输入 /输出文件给出建立和更新文件的

18、有关信息，如： 1文件的名称及编号 2记录媒体 3存留的目录 4文件的支配 说明确定保留文件或废弃文件的准就，分发文件的对象，占用硬件的优先级及保密掌握等。 4 启动或复原过程六特别规过程供应应急或特别规操作的必要信息及操作步骤，如出错处理操作、向后备系统切换操作以及保护人员须知的操作和留意事项。七操作命令一览表按字母次序逐个列出全部操作命令的格式功能及参数说明。 八程序文件或命令文件和数据文件一览表按文件名字母次序或按功能与模块分类次序逐个列出文件名称、标识符及说明。九用户操作举例可编辑资料 - - - 欢迎下载精品名师归纳总结测试方案 Test Plan 一、引言1. 编写目的阐明编写测试

19、方案的目的,指明读者对象。 2. 项目背景说明项目的来源托付单位及主管部门。 3. 定义列出测试方案中用到的特的术语定义和缩写词的原意。4. 参考资料列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：1项目的方案任务书，合同或批文。2项目开发方案。 3需求规格说明书。3概要设计说明书。 4具体设计说明书。 5用户操作手册 ; g 本测试方案中引用的其他资料采纳的软件开发标准或标准。 二任务概述1. 目标2. 运行环境3. 需求概述4. 条件与限制三方案1. 测试方案说明确定测试方法和选取测试用例的原就。2. 测试项目列出组装测试和确认测试中每一项测试的内容、名称、目的和进度

20、。3. 测试预备4. 测试机构及人员测试机构名称负责人和职责。 四测试项目说明按次序逐个对测试项目做出说明：1. 测试项目名称及测试内容2. 测试用例1输入输入的数据和输入的命令。2输出预期的输出数据。 3步骤及操作4答应偏差给出实测结果与猜测结果之间答应偏差的范畴。3. 进度4. 条件给出项测试对资源的特别要求，如设备、软件、人员等。5. 测试资料说明项测试所需的资料。五评判1. 范畴说明所完成的各项测试说明问题的范畴及其局限性。2. 准就说明评判测试结果的准就。可编辑资料 - - - 欢迎下载精品名师归纳总结测试分析报告 Test Specification一引言1. 编写目的阐明编写测试

21、分析报告的目的，指明读者对象。2. 项目背景说明项目的来源、托付单位及主管部门。3. 定义列出测试分析报告中用到的特的术语定义和缩写词的原意。4. 参考资料列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：1项目的方案任务书，合同或批文。2项目开发方案。 3需求规格说明书。4概要设计说明书。 5具体设计说明书。 6用户操作手册。 7测试方案。8测试分析报告所引用的其他资料、采纳的软件工程标准或软件工程标准。二测试方案执行情形1. 测试项目列出每一测试项目的名称、内容和目的。2. 测试机构和人员给出测试机构名称、负责人和参加测试人员名单。3. 测试结果按次序给出每一测试项目的

22、：1实测结果数据2与预期结果数据的偏差 3该项测试说明的事实4该项测试发觉的问题。 三软件需求测试结论按次序给出每一项需求测试的结论。包括：1证明的软件才能 2局限性即项需求未得到充分测试的情形及缘由。四评判1. 软件才能经过测试所说明的软件才能。2. 缺陷和限制说明测试所揭露的软件缺陷和不足,以及可能给软件运行带来的影响。3. 建议提出为补偿上述缺陷的建议。4. 测试结论说明能否通过。 可编辑资料 - - - 欢迎下载精品名师归纳总结开发进度月报一报告时间及所处的开发阶段二给出进度1. 本月内的主要活动2. 实际进展与方案比较三所用工时按不同层次人员分别计时。四全部机时按全部电脑机型分别计时

23、。五经费支出分类列出本月经费支出项目,给出支出总额，并与方案比较。六工作遇到的问题及实行的计策七本月完成的成果八下月的工作方案九特别问题可编辑资料 - - - 欢迎下载精品名师归纳总结项目开发总结报告一引言1. 编写目的阐明编写总结报告的目的,指明读者对象。 2. 项目背景说明项目的来源、托付单位、开发单位及主管部门。3. 定义列出报告中用到的特的术语定义和缩写词的原意。4. 参考资料列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：1项目的方案任务书，合同或批文。2项目开发方案。 3需求规格说明书。4概要设计说明书。 5具体设计说明书。 6用户操作手册。 7测试方案。8测

24、试分析报告9本报告引用的其他资料、采纳的开发标准或开发标准。二开发结果1. 产品可包括： 1列出各部分的程序名称、源程序行数包括注释行或目标程序字节数及程序总计数量、储备形式。产品文档名称等。2. 主要功能及性能3. 所用工时按人员的不同层次分别计时。4. 所用机时按所用电脑机型分别计时。5. 进度给出方案进度与实际进度的比照。6. 费用三评判1. 生产率评判如平均每人每月生产的源程序行数、文档的字数等。2. 技术方案评判3. 产品质量评判四体会与教训可编辑资料 - - - 欢迎下载精品名师归纳总结软件修改报告一登记号由软件配置治理部门为该报告规定的编号。二登记日期软件配置治理部门登记”软件修

25、改报告 ”的日期。三时间预备好”软件修改报告 ”的日期。四报告人填写该报告的作者。五子系统名受修改影响的子系统名。六模块名被修改的模块名。七 “软件问题报告 ”的编号被 ”软件修改报告 ”处理或部分处理的”软件问题报告 ”的编号。八修改包括程序修改、文件更新、数据库修改或他们的组合。九修改描述修改的具体描述。假如是文件更新或数据库修改，仍要列出文件更新通知或数据库修改申请的标识符。 十批准人批准人签字，正式批准进行修改。十一语句类型程序修改中涉及到的语句类型，包括：输入/输出语句类、运算语句类、规律掌握语句类、数据处理语句类如数据传送存取语句类 。十二程序名被修改的程序、文件或数据库名字。十三老修订版当前的版本 / 修订本标识。十四新修订版修改后的版本/修订本标识。十五数据库假如申请数据库修改,就给出数据库的标识符。 十六数据库修改报告数据库修改申请号。十七文件假如要求对文件进行修改，就给出文件的名字。十八文件更新文件更新通知单的编号。十九修改是否已测试指出已对修改做了哪些测试，如单元、子系统、组装、确认和运行测试等，并注明测试胜利与否。二十“软件问题报告 ”是否给出问题的精确描述二十一题注释精确的表达要保护的问题。二十二题源指明问题来自于哪里。二十三源完成修改所需资源的估量，即总的人时数和电脑时间的开销。可编辑资料 - - - 欢迎下载