软件开发标准规范文档

软件开发标准规范文档篇一：软件开发技术文档编写规范=软件开发技术文档编写规范 在项目开发过程中，应该按要求编写好十三种文档，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。 可行性分析报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。 项目开发计划：为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。 软件需求说明书（软件规格说明书）：对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。 概要设计说明书：该说明书是概要实际阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计提供基础。 详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。 用户操作手册：本手册详细描述软件的功能、性能和用户界面，使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。 测试计划：为做好集成测试和验收测试，需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。 测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。 开发进度月报：该月报系软件人员按月向管理部门提交的项目进展情况报告，报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。 项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对开发工作做出评价，总结出经验和教训。 软件维护手册：主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明，便于软件的维护。 软件问题报告：指出软件问题的登记情况，如日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。 软件修改报告：软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。 1 可行性分析报告 1 引言 编写目的：阐明编写可行性研究报告的目的，提出读者对象。 项目背景：应包括 所建议开发软件的名称 项目的任务提出者、开发者、用户及实现软件的单位 项目与其他软件或其他系统的关系。 定义：列出文档中用到的专门术语的定义和缩写词的原文。 参考资料：列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括 项目经核准的计划任务书、合同或上级机关的批文 与项目有关的已发表的资料 文档中所引用的资料，所采用的软件标准或规范 2 可行性研究的前提 要求：列出并说明建议开发软件的的基本要求，如 功能 性能 输入/输出 基本的数据流程和处理流程 安全与保密要求 与软件相关的其他系统 完成日期 目标：可包括 人力与设备费用的节省 处理速度的提高 控制精度或生产力的提高 管理信息服务的改进 决策系统的改进 人员工作效率的提高 条件、假定和限制：可包括 建议开发软件运行的最短寿命 进行显然方案选择比较的期限 经费来源和使用限制 法律和政策方面的限制 硬件、软件、运行环境和开发环境的条件和限制 可利用的信息和资源 建议开发软件投入使用的最迟时间可行性研究方法 决定可行性的主要因素 3 对现有系统的分析 处理流程和数据流程 工作负荷 费用支出：如人力、设备、空间、支持性服务、材料等项开支 人员：列出所需人员的专业技术类别和数量 设备 局限性：说明现有系统存在的问题以及为什么需要开发新的系统 4 所建议技术可行性分析 对系统的简要描述 与现有系统比较的优越性 处理流程和数据流程 采用建议系统可能带来的影响 对设备的影响 对现有软件的影响 对用户的影响 对系统运行的影响 对开发环境的影响 对经费支出的影响 技术可行性评价:包括 在限制条件下，功能目的是否达到 利用现有技术，功能目的是否达到 对开发人员数量和质量的要求，并说明能否满足 在规定的期限内，开发能否完成 5 所建议系统经济可行性分析 支出 效益 收益/投资比 投资回收周期敏感性分析：指一些关键性因素，如： 系统生存周期长短 系统工作负荷量 处理速度要求 设备和软件配置变化对支出和效益的影响等的分析 6 社会因素可行性分析 法律因素：如 合同责任 侵犯专利权 侵犯版权 用户使用可行性：如 用户单位的行政管理 工作制度 人员素质等能否满足要求 7 其他可供选择的方案 逐个阐明其它可供选择的方案，并重点说明未被推荐的理由。 8 结论意见 可着手组织开发 需等待若干条件具备后才能开发 需对开发目标进行某些修改 不能进行或不必进行 其它 2 项目开发计划 1 引言 编写目的：阐明编写可行性研究报告的目的，提出读者对象 项目背景：应包括 项目的委托单位、开发单位和主管部门； 该软件系统与其他系统的关系。 定义：列出文档中用到的专门术语的定义和缩写词的原文 参考资料：可包括： 项目经核准的计划任务书、合同或上级机关的批文 文档所引用的资料、规范等 列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源； 2 项目概述 工作内容:简要说明项目的各项主要工作，介绍所开发软件的功能、性能等；若不编写可行性研究报告；则应在本节给出较详细的介绍； 条件与限制: 阐明为完成项目应具备的条件、开发单位已具备的条件以及尚需创造的条件。必要时还应说明用户及分合同承担的工作、完成期限及其他条件与限制。 产品 程序：列出应交付的程序名称、使用的语言及存储形式。 文档：列出应交付的文档。 运行环境：应包括硬件环境、软件环境。 服务：阐明开发单位可向用户提供的服务。如人员培训、安装、保修、维护和其他运行支持。 验收标准 3 实施计划 任务分解：任务的划分及各项任务的负责人。 进度：按阶段完成的项目，用图表说明开始时间、完成时间。 预算 关键问题：说明可能影响项目的关键问题，如设备条件、技术难点或其他风险因素，并说明对策。 4 人员组织及分工 5 交付期限 6 专题计划要点 如测试计划、质量保证计划、配置管理计划、人员培训计划、系统安装计划等。 篇二：软件开发过程文档规范需求规格说明书 需求规格相当于软件开发的图纸，一般说，软件需求规格说明书的格式可以根据项目的具体情况采用不同的格式，没有统一的标准。下面是一个可以参照的软件需求规格说明书的模板。 1 导言 目的 说明编写这份项目需求规格的目的，指出预期的读者 背景 说明： a） 待开发的产品名称； b） 本项目的任务提出者、开发者、用户及实现该产品的单位； c） 该系统同其他系统的相互来往关系。 缩写说明 缩写 缩写说明 列出本文件中用到的外文首字母组词的原词组。 术语定义 术语 术语定义 列出本文件中用到的专门术语的定义。 参考资料 编号参考资料版本号 列出相关的参考资料。版本更新信息 具体版本更新记录如表所列。 表 版本更新记录 2 任务概述 系统定义 本节描述内容包括：? 项目来源及背景； ? 项目要达到的目标，如市场目标、技术目标等； ? 系统整体结构，如系统框架、系统提供的主要功能，涉及的接口等； ? 各组成部分结构，如果所定义的产品是一个更大的系统的一个组成部分， 则应说明本产品与该系统中其他各组成部分之间的关系，为此可使用一张方框图来说明该系统的组成和本产品同其他各部分的联系和接口。 应用环境 本节应根据用户的要求对系统的运行环境进行定义，描述内容包括： ? 设备环境； ? 系统运行硬件环境； ? 系统运行软件环境； ? 系统运行网络环境； ? 用户操作模式； ? 当前应用环境。 假定和约束 列出进行本产品开发工作的假定和约束，例如经费限制、开发期限等。列出本产品的最终用户的特点，充分说明操作人员、维护人员的教育水平和技术专长以及本产品的预期使用频度等重要约束。 3 需求规定对功能的规定 本节依据合同中定义的系统组成部分分别描述其功能，描述应包括： ? 功能编号； ? 所属产品编号； ? 优先级；? 功能定义； ? 功能描述。 对性能的规定 本节描述用户对系统的性能需求，可能的系统性能需求有： ? 系统响应时间需求； ? 系统开放性需求； ? 系统可靠性需求； ? 系统可移植性和可扩展性需求； ? 系统安全性需求； ? 现有资源利用性需求。 精度 说明对该产品的输入、输出数据精度的要求，可能包括传输过程中的精度。 时间特性要求 说明对于该产品的时间特性要求，如对： a） 响应时间； b） 更新处理时间； c） 数据的转换和传送时间； d） 计算时间等的要求。 灵活性 说明对该产品的灵活性的要求，即当需求发生某些变化时，该产品对这些变化的适应能力，如： a） 操作方式上的变化； b） 运行环境的变化； c） 同其他系统的接口的变化； d） 精度和有效时限的变化； e） 计划的变化或改进。 对于为了提供这些灵活性而进行的专门设计的部分应该加以标明。 输入输出的要求 解释各输入输出的数据类型，并逐项说明其媒体、格式、数值范围、精度等。对软件的数据输出及必须标明的控制输出量进行解释并举例，包括对硬拷贝报 告（正常结果输出、状态输出及异常输出）以及图形或显示报告的描述。 数据管理能力要求说明需要管理的文卷和记录的个数、表和文的大小规模，要按可预见的增长对数据及分量的存储要求做出估算。故障处理要求 列出可能的软件、硬件故障以及对各项性能而言所产生的后果和对故障处理的要求。 其他要求 如用户单位对安全保密的要求，对使用方便的要求，对可维护性、可补充性、易读性、可靠性、运行环境可转换性的特殊要求等。 4 运行环境规定 设备 列出该产品所需要的硬件环境。说明其中的新型设备及其专门功能，包括： a) 处理器型号及内存容量； b) 外存容量、联机或脱机、媒体及其存储格式。设备的型号及数量； c) 输入及输出设备的型号和数量，联机或脱机； d) 数据通信设备的型号和数量； e) 功能键及其他专用硬件。 支持软件 列出支持软件。包括要用到的操作系统、编译程序、测试软件等。 双方签字 需求方 （需方）： 开发方 （供方）： 日期： 概要设计说明书 概要设计说明书格式规范是指在概要设计阶段，制定概要设计报告所依据的标 准，若在承接产品时，用户提供了概要设计说明书，则按此标准检查概要设计报告是否在内容上满足要求，若未提供概要设计说明书则需按此标准建立概要设计说明书。这里提供一个标准以供参考。 1 导言 目的 说明文档的目的。 范围 说明文档覆盖的范围。 缩写说明 定义文档中所涉及的缩略语 （若无则填写无） 术语定义 定义文档内使用的特定术语 （若无则填写无） 引用标准 列出文档制定所依据、引用的标准 （若无则填写无） 参考资料列出文档制定所参考的资料 （若无则填写无） 版本更新信息 记录文档版本修改的过程，具体版本更新记录如表 1所列 表 版本更新记录 2 概述对系统定义和规格进行分析，并以此确定： ? 设计采用的标准和方法； ? 系统结构的考虑； ? 错误处理机制的考虑。 3 规格分析 根据需求规格或产品规格对系统实现的功能进行分析归纳，以便进行概要设计。 4 系统体系结构 根据已选用的软件、硬件以及网络环境构造系统的整体框架，划分系统模块，并对系统内各个模块之间的关系进行定义。确定已定义的对象及其组件在系统内如何传输、通信。如果本系统是用户最终投入使用系统的一个子集或是将要使用现有的一些其他相关系统，在此应对他们各自的功能和相互之间的关系给予具体的描述。可通过图形的方式表示系统体系结构 5 界面设计定义 设计用户的所有界面 6 接口定义 通常设计应考虑的接口包括： 人机交互接口 人机交互接口应确定用户采用何种方式同系统交互，如键盘录入、鼠标操作、文件输入等以及具体的数据格式，其中包括具体的用户界面的设计形式。尽早确定人机交互接口，有利于确定概要设计的其他方面。 用户界面设计原则： ? 命令排序：（1）最常用的放在前面； （2）按习惯工作步骤排序； ? 极小化：尽量少用键盘组合命令，减少用户击键次数； ? 广度和深度：由于人的记忆局限，层次不宜大于 3； ? 一致性：使用一致的术语、一致的步骤、一致的动作行为； ? 显示提示信息； ? 减少用户记忆内容； ? 存在删除操作时。应能恢复操作； ? 用户界面吸引人； 网络接口若本系统跨异种网络运行则应确定网络接口或采用何种网络软件，以使系 统各部分间能有效地联络、通信、交换信息等，从而使整个系统紧密有效的结合在一起。 系统与外部接口系统经常会与外部进行数据交换，因此应确定数据交换的时机、方式（如是批处理方式还是实时处理） 、数据交换的格式（如是采用数据包还是其他方式）等。 系统内模块之间的接口系统内部各模块之间也会进行数据交换，因此应确定数据交换的时机、方式等。 数据库接口系统内部的各种数据通常会以数据库的方式保存，因此在接口定义时应确定与数据库进行数据交换的数据格式、时机、方式等。 7 模块设计 根据项目的时机需求情况，可将系统划分成若干模块，分别描述各模块的功能。这样可将复杂的系统简化、细化，有利于今后的设计和实现。划分各模块时，应尽量使其具有封闭性和独立性，具有低耦合性，减少各模块之间的关联，使其便于实现、调试、安装和维护。 模块功能 描述该模块在整个系统中所处的位置和所起的作用以及和其他模块的相互关系，该模块要实现的功能，对外部输入数据外部触发机制的具体要求和规定。如果采用 OO 技术，可结合 Use Case 技术进行描述。 模块对象（组件） 对模块涉及的输入/输出，用户界面、对象或组件，对象或组件的关系以及功能实现流程进行定义。如果采用OO 技术，可使用顺序（sequence）图描述功能实现流程。 对象设计应包括： Class Name （类名） ； Describe （类描述） ； Hierarchy （继承关系） ； Public Attribute （公共属性） Public Operation （公共操作）Private Attribute （私有属性） Private Operation （私有操作） Protected Attribute （保护属性） Protected Operation （保护操作） 组件设计应包括： ? 组件属性； ? 组件关联； ? 组件操作； ? 实现约束。 对象（组件）的触发机制 规定对象（组件）中各个操作在什么外部条件触发下被调用以及调用后的结果。 对象（组件）的关键算法 如果对象（组件）中涉及关键算法，如采用何种算法加密、何种算法搜索等， 篇三：软件项目开发的文档编写标准化软件项目开发的文档编写标准化 在项目开发过程中，应该按要求编写好十三种文档，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。 可行性分析报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。 项目开发计划：为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。 软件需求说明书(软件规格说明书)：对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。 概要设计说明书：该说明书是概要实际阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计提供基础。 详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。 用户操作手册：本手册详细描述软件的功能、性能和用户界面，使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。 测试计划：为做好集成测试和验收测试，需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。 测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。 开发进度月报：该月报系软件人员按月向管理部门提交的项目进展情况报告，报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。 项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对开发工作做出评价，总结出经验和教训。 软件维护手册：主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明，便于软件的维护。 软件问题报告：指出软件问题的登记情况，如日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。 软件修改报告：软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。 项目开发计划 1 引言 编写目的：阐明编写可行性研究报告的目的，提出读者对象 项目背景：应包括 项目的委托单位、开发单位和主管部门； 该软件系统与其他系统的关系。 定义：列出文档中用到的专门术语的定义和缩写词的原文 参考资料：可包括 项目经核准的计划任务书、合同或上级机关的批文 文档所引用的资料、规范等 列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源； 2 项目概述 工作内容：简要说明项目的各项主要工作，介绍所开发软件的功能、性能 等；若不编写可行性研究报告；则应在本节给出较详细的介绍； 条件与限制：阐明为完成项目应具备的条件、开发单位已具备的条件以及 尚需创造的条件。必要时还应说明用户及分合同承担的工 作、完成期限及其他条件与限制。 产品 程序：列出应交付的程序名称、使用的语言及存储形式。 文档：列出应交付的文档。 运行环境：应包括硬件环境、软件环境。 服务：阐明开发单位可向用户提供的服务。如人员培训、安装、保修、维 护和其他运行支持。 验收标准 3 实施计划 任务分解：任务的划分及各项任务的负责人。 进度：按阶段完成的项目，用图表说明开始时间、完成时间。 预算 关键问题：说明可能影响项目的关键问题，如设备条件、技术难点或其他 风险因素，并说明对策。 4 人员组织及分工 5 交付期限 6 专题计划要点 如测试计划、质量保证计划、配置管理计划、人员培训计划、系统安装计划等。 软件需求说明书 1 引言 编写目的：阐明编写需求说明书的目的，指明读者对象。 项目背景：应包括 项目的委托单位、开心单位和主管部门； 该软件