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

1、软件开发文档编写指南软件文档编写指南 封面格式： .2 系统规约说明书System Specification .3 软件项目可行性研究报告Report for Feasibility Study .4 软件项目计划Software Project Plan .6 需求规格说明书Requirements Specification .7 概要设计说明书Architectural Design Specification.8 详细设计说明书Procedural Design Specificatio n .9 用户操作手册User Guide .10 测试计划Test Plan .12 测试分析

2、报告Test Specification.13 开发进度月报.14 项目开发总结报告.15 软件修改报告.16 1/16 软件文档编写指南 封面格式： 文档编号版 本 号文档名称：项目名称：项目负责人：编写 年 月 日 校对 年 月 日 审核 年 月 日 批准 年 月 日 开发单位- 2 - 软件文档编写指南 系统规约说明书System Specification 一引言 A. 文档的范围和目的 B. 概述 1目标 2约束 二功能和数据描述 A. 系统结构 1结构关系图 2结构关系图描述 三子系统描述 A. 子系统 N 的结构图规约说明 B. 结构字典 C. 结构连接图和说明 四系统建模和模拟

3、结构 A. 用于模拟的系统模型 B. 模拟结果 C. 特殊性能 五软件项目问题 A. 软件项目可行性研究报告 B. 软件项目计划 六附录 - 3 - 软件文档编写指南 软件项目可行性研究报告Report for Feasibility Study 一引言 1编写目的阐明编写可行性研究报告的目的，指出读者对象 2项目背景应包括：1所建议开发的软件名称；2项目的任务提出者、开发者、用户及实现单位；3项目与其他软件或其他系统的关系。 3定义列出文档中用到的专门术语的定义和缩略词的原文。 4参考资料列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。 二可行性研究的前提 1 要求列出并说明建

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

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

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

7、能是：1可着手组织开发；2需待假设干条件如资金、人力设备等具备后才能开发；3需对开发目标进行某些修改；4不能进行或不必进行如技术不成熟，经济上不合算等；4其他。 - 5 - 软件文档编写指南 软件项目计划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关键问题说明可能影响项目的关键问题,如设备条件 技术难点或其他风险因素,并说明对策。 四人员组织及分工 五交付期限 六专题计划要点如测试计划 质量保证计划 配置管理计划 人员培训计划 系统安装计划等。 - 6 - 软件文档编写指南 需求规格说明书Requirements Specification 一引言 1 编写目的阐明编写需求说明书的目的,指明读者对象。 2 项目背景可包括：1项目的委托单位,开发单位和主管部门；2该软件系统与其他系统的关系。 3 定义列出文档中用到的专门术语定义和缩写词的原文。 4 参考资料可包括：1项目经核准的计划任务书

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

11、输出时间等。 2硬件接口 3软件接口 4故障处理 七其他需求如可使用性、安全保密、可维护性、可移植性等。 - 7 - 软件文档编写指南 概要设计说明书Architectural Design Specification 一引言 1编写目的阐明编写概要设计说明书的目的，指明读者对象。 2项目背景可包括：1项目的委托单位,开发单位和主管部门；2该软件系统与其他系统的关系。 3定义列出文档中用到的专门术语定义和缩写词的原意。 4参考资料列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：1项目经核准的计划任务书，合同或上机机关的批文；2项目开发计划；3需求规格说明书；4测试计划初稿

12、；5用户操作手册初稿；6文档所引用的资料、采用的标准或标准。 二任务概述 1目标 2运行环境 3需求概述 4条件与限制 三总体设计 1处理流程 2总体结构和模块外部设计 3功能分配说明各项功能与程序结构的关系。 四接口设计 1外部接口包括用户界面 软件接口与硬件接口。 2内部接口模块之间的接口。 五数据结构设计 1 逻辑结构设计 2 物理结构设计 3 数据结构与程序的关系 六运行设计 1运行模块的组合 2运行控制 3运行时间 七出错处理设计 1出错输出信息 2出错处理对策如设置后备、性能降级、恢复及再启动等。 八安全保密设计 九维护设计说明为方便维护工作的设施,如维护模块等。 - 8 - 软件

13、文档编写指南 详细设计说明书Procedural Design Specification 一引言 1 编写目的阐明编写详细设计说明书的目的,指明读者对象。 2 项目背景应包括项目的来源和主管部门等。 3 定义列出文档中用到的专门术语定义和缩写词的原意。 4 参考资料列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：1项目的计划任务书,合同或批文；2项目开发计划；3需求规格说明书；3概要设计说明书；4测试计划(初稿)；5用户操作手册(初稿)；5文档所引用的其他资料、软件开发标准或标准。 二总体设计 1需求概述 2软件结构如给出软件系统的结果图。 三程序描述逐个模块给出以下的

14、说明:： 1功能 2性能 3输入项目 4输出项目 5算法模块所选用的算法。 6程序逻辑详细描述模块实现的算法，可采用:：1标准流程图；2PDL 语言；3N-S 图；4PAD；5判定表等描述算法的图表。 7接口 8存储分配 9限制条件 10 测试要点给出测试模块的主要测试要求。 - 9 - 软件文档编写指南 用户操作手册User Guide 一引言 1编写目的阐明编写手册的目的，指明读者对象。 2项目背景说明项目的来源、委托单位、开发单位及主管部门。 3定义列出手册中用到的专门术语定义和缩写词的原意。 4参考资料列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：1项目的计划任

15、务书,合同或批文；2项目开发计划；3需求规格说明书；4概要设计说明书；5详细设计说明书；6测试计划；7手册中引用的其他资料、采用的软件工程标准或软件工程标准。 二软件概述 1目标 2功能 3性能 1数据精确度包括输入、输出及处理数据的精度。 2时间特性如响应时间、处理时间、数据传输时间等。 3灵活性在操作方式、运行环境需做某些变更时软件的适应能力。 三运行环境 1硬件列出软件系统运行时所需的硬件最小配置，如：1电脑型号、主存容量；2外存储器、媒体、记录格式、设备型号及数量；3输入、输出设备；4数据传输设备及数据转换设备的型号及数量。 2支持软件如：1操作系统名称及版本号；2语言编译系统或汇编系

16、统的名称及版本号；3数据库管理系统的名称及版本号；4其他必要的支持软件。 四使用说明 1安装和初始化给出程序的存储形式、操作命令、反馈信息及其含义、说明安装完成的测试实例以及安装所需的软件工具等。 2输入给出输入数据或参数的要求。 1数据背景说明数据来源、存储媒体、出现频度、限制和质量管理等。 2数据格式如：1长度2格式基准3标号4顺序5分隔符6词汇表7省略和重复8控制。 3输入举例 3输出给出每项输出数据的说明。 1数据背景说明输出数据的去向、使用频度、存放媒体及质量管理等。 2数据格式详细阐明每一输出数据的格式,如:首部 主体和尾部的具体形式。 3举例 3出错和恢复给出：1出错信息及其含义

17、2用户应采取的措施，如修改、恢复、再启动。 4求助查询说明如何操作。 五运行说明 1 运行表 列出每种可能的运行情况,说明其运行目的. 2 运行步骤 按顺序说明每种运行的步骤,应包括: - 10 - 软件文档编写指南 1 运行控制 2 操作信息1运行目的2操作要求3启动方法4预计运行时间5操作命令格式及说明6其他事项。 3 输入/输出文件给出建立和更新文件的有关信息，如：1文件的名称及编号2记录媒体3存留的目录4文件的支配说明确定保留文件或废弃文件的准则，分发文件的对象，占用硬件的优先级及保密控制等。 4 启动或恢复过程 六非常规过程提供给急或非常规操作的必要信息及操作步骤，如出错处理操作、向

18、后备系统切换操作以及维护人员须知的操作和注意事项。 七操作命令一览表 按字母顺序逐个列出全部操作命令的格式 功能及参数说明。 八程序文件或命令文件和数据文件一览表按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。 九用户操作举例 - 11 - 软件文档编写指南 测试计划Test Plan 一、引言 1 编写目的阐明编写测试计划的目的,指明读者对象。 2 项目背景说明项目的来源 委托单位及主管部门。 3 定义列出测试计划中用到的专门术语定义和缩写词的原意。 4 参考资料列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：1项目的计划任务书，合同或批文；2项目

19、开发计划；3需求规格说明书；3概要设计说明书；4详细设计说明书；5用户操作手册; g 本测试计划中引用的其他资料 采用的软件开发标准或标准。 二任务概述 1目标 2运行环境 3需求概述 4条件与限制 三计划 1测试方案说明确定测试方法和选取测试用例的原则。 2测试项目列出组装测试和确认测试中每一项测试的内容、名称、目的和进度。 3测试准备 4测试机构及人员测试机构名称 负责人和职责。 四测试项目说明按顺序逐个对测试项目做出说明： 1测试项目名称及测试内容 2测试用例 1输入输入的数据和输入的命令。 2输出预期的输出数据。 3步骤及操作 4允许偏差给出实测结果与预测结果之间允许偏差的范围。 3

20、进度 4 条件给出项测试对资源的特殊要求，如设备、软件、人员等。 5 测试资料说明项测试所需的资料。 五评价 1范围说明所完成的各项测试说明问题的范围及其局限性。 2准则说明评价测试结果的准则。 - 12 - 软件文档编写指南 测试分析报告Test Specification 一引言 1编写目的阐明编写测试分析报告的目的，指明读者对象。 2项目背景说明项目的来源、委托单位及主管部门。 3定义列出测试分析报告中用到的专门术语定义和缩写词的原意。 4参考资料列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：1项目的计划任务书，合同或批文；2项目开发计划；3需求规格说明书；4概要

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

22、来的影响。 3建议提出为弥补上述缺陷的建议。 4测试结论说明能否通过。 - 13 - 软件文档编写指南 开发进度月报 一报告时间及所处的开发阶段 二给出进度 1 本月内的主要活动 2 实际进展与计划比较 三所用工时按不同层次人员分别计时。 四所有机时按所有电脑机型分别计时。 五经费支出分类列出本月经费支出项目,给出支出总额，并与计划比较。 六工作遇到的问题及采取的对策 七本月完成的成果 八下月的工作计划 九特殊问题 - 14 - 软件文档编写指南 项目开发总结报告 一引言 1编写目的阐明编写总结报告的目的,指明读者对象。 2项目背景说明项目的来源、委托单位、开发单位及主管部门。 3定义列出报告

23、中用到的专门术语定义和缩写词的原意。 4参考资料列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：1项目的计划任务书，合同或批文；2项目开发计划；3需求规格说明书；4概要设计说明书；5详细设计说明书；6用户操作手册；7测试计划；8测试分析报告9本报告引用的其他资料、采用的开发标准或开发标准。 二开发结果 1 产品可包括：1列出各部分的程序名称、源程序行数包括注释行或目标程序字节数及程序总计数量、存储形式；产品文档名称等。 2 主要功能及性能 3 所用工时按人员的不同层次分别计时。 4 所用机时按所用电脑机型分别计时。 5 进度给出计划进度与实际进度的比照。 6 费用 三评价

24、 1生产率评价如平均每人每月生产的源程序行数、文档的字数等。 2技术方案评价 3产品质量评价 四经验与教训 - 15 - 软件文档编写指南 软件修改报告 一登记号由软件配置管理部门为该报告规定的编号。 二登记日期软件配置管理部门登记”软件修改报告”的日期。 三时间准备好”软件修改报告”的日期。 四报告人填写该报告的作者。 五子系统名受修改影响的子系统名。 六模块名被修改的模块名。 七“软件问题报告”的编号被”软件修改报告”处理或部分处理的”软件问题报告”的编号。 八修改包括程序修改、文件更新、数据库修改或他们的组合。 九修改描述修改的详细描述。如果是文件更新或数据库修改，还要列出文件更新通知或数据库修改申请的标识符。 十批准人批准人签字，正式批准进行修改。 十一 语句类型程序修改中涉及到的语句类型，包括：输入/输出语句类、计算语句类、逻辑控制语句类、数据处理语句类(如数据传送 存取语句类)。 十二 程序名被修改的程序、文件或数据库名字。 十三 老修订版当前的版本/修订本标识。 十四 新修订版修改后的版本/修订本标识。 十五 数据库如果申请数据库修改,则给出数据库的标识符。 十六 数据库修改报告数据库修改申请号。 十七 文件如果要求对文件进行修改，则给出文件的名字。 十