软件开发文档编写要求

软件开发文档编写要求

在项目开发过程中，应该按要求编写好十三种文档，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。

◇可行性分析报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。

◇项目开发计划：为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。

◇软件需求说明书（软件规格说明书）：对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。

◇概要设计说明书：该说明书是概要实际阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计提供基础。

◇详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。

◇用户操作手册：本手册详细描述软件的功能、性能和用户界面，使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。

◇测试计划：为做好集成测试和验收测试，需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

◇测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。

◇开发进度月报：该月报系软件人员按月向管理部门提交的项目进展情况报告，报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。

◇项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对开发工作做出评价，总结出经验和教训。

◇软件维护手册：主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明，便于软件的维护。

◇软件问题报告：指出软件问题的登记情况，如日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。

◇软件修改报告：软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。

1可行性分析报告

1 引言

1.1 编写目的：阐明编写可行性研究报告的目的，提出读者对象。

1.2 项目背景：应包括

●所建议开发软件的名称

●项目的任务提出者、开发者、用户及实现软件的单位

●项目与其他软件或其他系统的关系。

1.3 定义：列出文档中用到的专门术语的定义和缩写词的原文。

1.4 参考资料：列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括

●项目经核准的计划任务书、合同或上级机关的批文

●与项目有关的已发表的资料

●文档中所引用的资料，所采用的软件标准或规范

2 可行性研究的前提

2.1 要求：列出并说明建议开发软件的的基本要求，如

●功能

●性能

●输入/输出

●基本的数据流程和处理流程

●安全与保密要求

●与软件相关的其他系统

●完成日期

2.2 目标：可包括

●人力与设备费用的节省

●处理速度的提高

●控制精度或生产力的提高

●管理信息服务的改进

●决策系统的改进

●人员工作效率的提高

2.3 条件、假定和限制：可包括

●建议开发软件运行的最短寿命

●进行显然方案选择比较的期限

●经费来源和使用限制

●法律和政策方面的限制

●硬件、软件、运行环境和开发环境的条件和限制

●可利用的信息和资源

●建议开发软件投入使用的最迟时间

2.4 可行性研究方法

2.5 决定可行性的主要因素

3 对现有系统的分析

3.1 处理流程和数据流程

3.2 工作负荷

3.3 费用支出：如人力、设备、空间、支持性服务、材料等项开支3.4 人员：列出所需人员的专业技术类别和数量

3.5 设备

3.6 局限性：说明现有系统存在的问题以及为什么需要开发新的系统

4 所建议技术可行性分析

4.1 对系统的简要描述

4.2 与现有系统比较的优越性

4.3 处理流程和数据流程

4.4 采用建议系统可能带来的影响

●对设备的影响

●对现有软件的影响

●对用户的影响

●对系统运行的影响

●对开发环境的影响

●对经费支出的影响

4.5 技术可行性评价:包括

●在限制条件下，功能目的是否达到

●利用现有技术，功能目的是否达到

●对开发人员数量和质量的要求，并说明能否满足

●在规定的期限内，开发能否完成

5 所建议系统经济可行性分析

5.1 支出

5.2 效益

5.3 收益/投资比

5.4 投资回收周期

5.5 敏感性分析：指一些关键性因素，如：

●系统生存周期长短

●系统工作负荷量

●处理速度要求

●设备和软件配置变化对支出和效益的影响等的分析

6 社会因素可行性分析

6.1 法律因素：如

●合同责任

●侵犯专利权

●侵犯版权

6.2 用户使用可行性：如

●用户单位的行政管理

●工作制度

●人员素质等能否满足要求

7 其他可供选择的方案

逐个阐明其它可供选择的方案，并重点说明未被推荐的理由。

8 结论意见

●可着手组织开发

●需等待若干条件具备后才能开发

●需对开发目标进行某些修改

●不能进行或不必进行

●其它

2项目开发计划

1 引言

1.1 编写目的：阐明编写可行性研究报告的目的，提出读者对象

1.2 项目背景：应包括

●项目的委托单位、开发单位和主管部门；

●该软件系统与其他系统的关系。

1.3 定义：列出文档中用到的专门术语的定义和缩写词的原文

1.4 参考资料：可包括：

●项目经核准的计划任务书、合同或上级机关的批文

●文档所引用的资料、规范等

●列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源；

2 项目概述

2.1 工作内容:简要说明项目的各项主要工作，介绍所开发软件的功能、性能等；若不编写可行性研究报告；则应在本节给出较详细的介绍；

2.2 条件与限制: 阐明为完成项目应具备的条件、开发单位已具备的条件以及尚需创造的条件。必要时还应说明用户及分合同承担的工作、完成期限及其他条件与限制。

2.3 产品

2.3.1程序：列出应交付的程序名称、使用的语言及存储形式。

2.3.2文档：列出应交付的文档。

2.4 运行环境：应包括硬件环境、软件环境。

2.5 服务：阐明开发单位可向用户提供的服务。如人员培训、安装、保修、维护和其他运行支持。

2.6 验收标准

3 实施计划

3.1 任务分解：任务的划分及各项任务的负责人。

3.2 进度：按阶段完成的项目，用图表说明开始时间、完成时间。

3.3 预算

3.4 关键问题：说明可能影响项目的关键问题，如设备条件、技术难点或其他风险因素，并说明对策。

4 人员组织及分工

5 交付期限

6 专题计划要点

如测试计划、质量保证计划、配置管理计划、人员培训计划、系统安装计划等。

3软件需求说明书

1 引言

1.1 编写目的：阐明编写需求说明书的目的，指明读者对象。

1.2 项目背景：应包括

●项目的委托单位、开心单位和主管部门；

●该软件系统与其他系统的关系。

1.3 定义：列出文档中所用到的专门术语的定义和缩写词的愿文。

1.4 参考资料：可包括

●项目经核准的计划任务书、合同或上级机关的批文

●文档所引用的资料、规范等

●列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源

2 任务概述

2.1 目标

2.2 运行环境

2.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.3 软件接口

6.4 故障处理

7 其他需求

如可使用性、安全保密、可维护性、可移植性等。

4概要设计说明书

1 引言

1.1 写目的：阐明编写概要设计说明书的目的，指明读者对象。

1.2 项目背景：应包括

●项目的委托单位、开发单位和主管部门

●该软件系统与其他系统的关系。

1.3 定义：列出本文档中所用到的专门术语的定义和缩写词的愿意。

1.4 参考资料：

●列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源

●项目经核准的计划任务书、合同或上级机关的批文；项目开发计划；需求规格说明书；测试计划（初稿）；用户操作手册

●文档所引用的资料、采用的标准或规范。

2 任务概述

2.1 目标

2.2 需求概述

2.3 条件与限制

3 总体设计

3.2 总体结构和模块外部设计

3.3 功能分配：表明各项功能与程序结构的关系。

4 接口设计

4.1 外部接口：包括用户界面、软件接口与硬件接口。

4.2 内部接口：模块之间的接口。

5 数据结构设计

6 逻辑结构设计

所有文档的统一封面格式如下页所示。

7 物理结构设计

8 数据结构与程序的关系

9 运行设计

9.1 运行模块的组合

9.2 运行控制

9.3 运行时间

10 出错处理设计

10.1 出错输出信息

10.2 出错处理对策：如设置后备、性能降级、恢复及再启动等。

11 安全保密设计

12 维护设计

说明为方便维护工作的设施，如维护模块等。

5详细设计说明书

1 引言

1.1 编写目的：阐明编写详细设计说明书的目的，指明读者对象。

1.2 项目背景：应包括项目的来源和主管部门等。

1.3 定义：列出本文档中所用到的专门术语的定义和缩写词的愿意。

1.4 参考资料：

●列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源

●项目经核准的计划任务书、合同或上级机关的批文；项目开发计划；需求规格说明书；概要设计说明书；测试计划（初稿）；用户操作手册

●文档所引用的资料、软件开发的标准或规范。

2 总体设计

2.1 需求概述

2.2 软件结构：如给出软件系统的结构图。

3 程序描述

3.1 逐个模块给出以下说明：

●功能

●性能

●输入项目

●输出项目

3.2 算法：模块所选用的算法。

3.3 程序逻辑：详细描述模块实现的算法，可采用：标准流程图；PDL语言；N-S 图；判定表等描述算法的图表。

3.4 接口

●存储分配

●限制条件

3.5测试要点：给出测试模块的主要测试要求。

6用户操作手册

1 引言

1.1 编写目的：阐明编写手册的目的，指明读者对象。

1.2 项目背景：说明项目的来源、委托单位、开发单位及和主管部门。

1.3 定义：列出手册中使用的专门术语的定义和缩写词的愿意。

1.4 参考资料：

●列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源

●项目经核准的计划任务书、合同或上级机关的批文；项目开发计划；需求规格说明书；概要设计说明书；详细设计说明书；测试计划

●文档中所引用的其他资料、采用的软件工程标准或软件工程规范。

2 软件概述

2.1 目标

2.2 功能

2.3 性能

2.4 数据精确度：包括输入、输出及处理数据的精度。

2.5 时间特性：如响应时间、处理时间、数据传输时间等。

2.6 灵活性：在操作方式、运行环境需做某些变更时软件的适应能力。

3 运行环境

3.1 硬件

●列出软件系统运行时所需的硬件最小配置，如计算机型号、主存容量

●外存储器、媒体、记录格式、设备型号及数量

●输入、输出设备

●数据传输设备及数据转换设备的型号及数量。

3.2 支持软件

●操作系统名称及版本号

●语言编译系统或汇编系统的名称及版本号

●数据库管理系统的名称及版本号

●其他必要的支持软件

4 使用说明

4.1 安装和初始化：给出程序的存储形式、操作命令、反馈信息及其做含意、表明安装完成的测试实例以及安装所需的软件工具等。

4.2 输入：给出输入数据或参数的要求。

●数据背景：说明数据来源、存储媒体、出现频度、限制和质量管理等。

●数据格式:如长度、格式基准、标号、顺序、分隔符、词汇表、省略和重复、控制。

●输入举例。

4.3 输出：给出每项输出数据的说明。

●数据背景：说明输出数据的去向、使用频度、存放媒体及质量管理等。

●数据格式：详细阐明每一输出数据的格式，如首部、主体和尾部的具体形式。

●举例

4.4 出错和恢复：给出出错信息及其含意；用户应采取的措施，如修改、恢复、再启动。

4.5 求助查询：说明如何操作。

5 运行说明

5.1 运行表：列出每种可能的运行情况，说明其运行目的。

5.2 运行步骤：按顺序说明每和运行的步骤，应包括：

5.3 运行控制

5.4 操作信息：运行目的、运行目的、操作要求、启动方法、预计运行时间、操作命令格式及说明、其他事项；

5.5输入/输出文件：给出建立或更新文件的有关信息，如：文件的名称及编号；记录媒体；存留的目录；文件的支配：说明确定保留文件或废弃文件的准则，分发文件的对象，战胜硬件的优先级及保密控制等。

5.6 启动或恢复过程

6 非常规过程

提供应急戒非常规操作的必要信息及操作步骤，如出错处理操作、向后备系统切换操作及维护人员须知的操作和注意事项。

7 操作命令一览表

按字母顺序逐个列出全部操作命令的格式、功能及参数说明。

8 程序文件（或命令文件）和数据文件一览表

按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。

9 用户操作举例

7测试计划

1 引言

1.1 编写目的：阐明编写测试计划的目的并指明读者对象。

1.2 项目背景：说明项目的来源、委托单位及主管部门。

1.3 定义：列出测试计划中所用到的专门术语的定义和缩写词的原意。

1.4参考资料：列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：项目的计划任务书、合同或批文；项目开发计划；需求规格说明书；概要设计说明书；详细设计说明书；用户操作手册；本测试计划中引用的其他资料、采用的软件开发标准或规范。

2 任务概述

2.1 目标

2.2 运行环境

2.3 需求概述

2.4 条件与限制

3 计划

3.1 测试方案：说明测试方法和选取测试用例的原则。

3.2 测试项目：列出组装测试和确认测试中每一项测试的内容、名称、目的和进度。

3.3 测试准备

3.4 测试机构及人员：测试机构名称、负责人和职责。

4 测试项目说明

4.1 按顺序逐个对测试项目做出说明

4.1.1 测试项目名称及测试内容

4.1.2 测试用例

4.1.3 输入：输入的数据和输入命令。

4.1.4 输出：预期的输出数据。

4.2 步骤及操作

4.3 允许偏差：给出实测结果与预期结果之间允许偏差的范围。

4.4 进度

4.5 条件：给出项测试对资源的特殊要求，如设备、软件、人员等。

4.6 测试资料：说明项测试所需的资料。

5 评价

5.1 范围：说明所完成的各项测试说明问题的范围及其局限性。

5.2 准则：说明评论测试结果的准则。

8测试分析报告

1 引言

1.1 编写目的：阐明编写测试分析报告的目的并指明读者对象。

1.2 项目背景：说明项目的来源、委托单位及主管部门。

1.3定义：列出测试分析报告中所用到的专门术语的定义和缩写词的原意。

1.4参考资料：列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：项目的计划任务书、合同或批文；项目开发计划；需求规格说明书；概要设计说明书；详细设计说明书；用户操作手册；测试计划；测试分析报告所引用的其他资料、采用的软件工程标准或工程规范。

2 测试计划招待情况

2.1 机构和人员：给出测试机构名称、负责人和参与测试人员名单。

2.2 测试结果：按顺序给出每一测试项目的：实测结果数据；与预期结果数据的偏差；该项测试表明的事实；该项测试发现的问题。

3 软件需求测试结论

按顺序给出每一项需求测试的结论。包括：证实的软件能力；局限性（即项需求未得到充分测试的情况及原因。

4 评价

4.1 软件能力：经过测试所表明的软件能力。

4.2 缺陷和限制：说明测试所揭露的软件缺陷和不足，以及可能给软件运行带来的影响。

4.3 建议：提出为弥补上述缺陷的建议。

4.4 测试结论：说明能否通过。

9开发进度月报

1 报告时间及所处的开发阶段

2 工程进度

2.1 本月内的主要活动

2.2 实际进展与计划比较

3 所用工时

按不同层次人员分别计时。

4 所用机时

按所用计算机机型分别计时。

5 经费支出

分类列出本月经费支出项目，给出支出总额，并与计划比较。

6 工作遇到的问题及采取的对策

7 本月完成的成果

8 下月的工作计划

9 特殊问题

10项目开发总结报告

1 引言

1.1 编写目的：阐明编写总结报告的目的并指明读者对象。

1.2 项目背景：说明项目的来源、委托单位、开发单位及主管部门。

1.3 定义：列出报告中所用到的专门术语的定义和缩写词的原意。

1.4参考资料：列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：项目的计划任务书、合同或批文；项目开发计划；需求规格说明书；概要设计说明书；详细设计说明书；用户操作手册；测试计划；测试分析报告；本报告引用的其他资料、采用的开发标准或开发规范。

2 开发结果

2.1 产品：可包括列出各部分的程序名称、源程序行数（包括注释行）或目标程序字节数及程序总计数量、存储形式；产品文档名称等。

2.2 主要功能及性能

2.3 所用工时：按人员的不同层次分别计时。

2.4 所用机时：按所用计算机机型分别计时。

2.5 进度：给出计划进度与实际进度的对比。

2.6 费用

3 评价

3.1 生产率评价：如平均每人每月生产的源程序行数、文档的字数等。

3.2 技术方案评价

3.3 产品质量评价

4 经验与教训

11软件维护手册

1 引言

1.1 编写目的：阐明编写手册的目的并指明读者对象。

1.2 项目背景：说明项目的提出者、开发者、用户和使用场所。

1.3 定义：列出报告中所用到的专门术语的定义和缩写词的原意。

1.4 参考资料：列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，及保密级别，可包括：用户操作手册；与本项目有关的其他文档。

2 系统说明

2.1 系统用途：说明系统具备的功能，输入和输出。

2.2 安全保密：说明系统安全保密方面的考虑。

2.3 总体说明：说明系统的总体功能，对系统、子系统和作业做出综合性的介绍，并用图表的方式给出系统主要部分的内部关系。

2.4 程序说明：说明系统中每一程序、分程序的细节和特性。

2.4.1 程序1的说明

●功能：说明程序的功能。

●方法：说明实现方法。

●输入：说明程序的输入、媒体、运行数据记录、运行开始时使用的输入数据的类型和存放单元、与程序初始化有关的入口要求。

●处理：处理特点和目的，如：用图表说明程序的运行的逻辑流程；程序主要转移条件；对程序的约束条件；程序结束时的出口要求；与下一个程序的通信与联结（运行、控制）；由该程序产生并茶馆处理程序段使用的输出数据类型和存放单元；程序运行存储量、类型及存储位置等。

●输出：程序的输出。

●接口：本程序与本系统其他部分的接口。

●表格：说明程序内部的各种表、项的细节和特性。对每张表的说明至少包括：表的标识符；使用目的；使用此表的其他程序；逻辑划分，如块或部，不包括表项；表的基本结构；设计安排，包括表的控制信息。表目结构细节、使用中的特有性质及各表项的标识、位置、用途、类型、编码表示。

●特有的运行性质：说明在用户操作手册中没有提到的运行性质。

2.4.2程序2的说明

与程序1的说明相同。以后的其他各程序的说明相同。

3 操作环境

3.1 设备：逐项说明系统的设备配置及其特性。

3.2 支持软件：列出系统使用的支持软件，包括它们的名称和版本号。

3.3 数据库：说明每个数据库的性质和内容，包括安全考虑。

3.3.1总体特征：如标识符、使用这些数据库的程序、静态数据、动态数据；数据库的存储媒体；程序使用数据库的限制。

3.3.2结构及详细说明

●说明该数据库的结构，包括其中的记录和项。

●说明记录的组成，包括首部或控制段、记录体。

●说明每个记录结构的字段，包括：标记或标号、字段的字符长度和位数、该字段的允许值范围。

●扩充：说明为记录追加字段的规定。

4 维护过程

4.1 约定：列出该软件系统设计中所使用全部规则和约定，包括：程序、分程序、记录、字段和存储区的标识或标号助记符的使用规则；图表的处理标准、卡片的连接顺序、语句和记号中使用的缩写、出现在图表中的符号名；使用的软件技术标准；标准化的数据元素及其特征。

4.2 验证过程：说明一个程序段修改后，对其进行验证的要求和过程（包括测试程序和数据）及程序周期性验证的过程。

4.3 出错及纠正方法：列出出错状态及其纠正方法。

4.4 专门维护过程：说明文档其他地方没有提到的专门维护过程。如：维护该软件系统的输入输出部分（如数据库）的要求、过程和验证方法；运行程序库维护系统所必需的要求、过程和验证方法；对闰年、世纪变更的所需要的临时性修改等。

4.5 专用维护程序：列出维护软件系统使用的后备技术和专用程序（如文件恢复程序、淘汰过时文件的程序等）的目录，并加以说明，内容包括：维护作业的输入输出要求；输入的详细过程及在硬设备上建立、运行并完成维护作业的操作步骤。

4.6 程序清单和流程图：引用或提供附录给出程序清单和流程图。

12软件问题报告

1 登记号

由软件配置管理部门为该报告规定一个唯一的、顺序的编号。

2 登记日期

软件配置管理部门登记该报告的日期。

3 问题发现日期

发现该问题的日期和时间。

4 活动

在哪个阶段发现的问题，分为单元测试、组装测试、确认测试和运行维护。

5 状态

在软件配置记录中维护的动态指示，状态表示有：正在复查"软件问题报告"，以确定将采取什么行动；"软件问题报告"已由指定的人去进行处理；修改已完成，并经过测试，正准备交给主程序库；主程序库已经更新，主程序库修改的重新测试沿未完成；做了重新测试，问题再现；做了重新测试，所做的修改无故障，"软件问题报告"被关闭；留待以后关闭。

6 报告人

填写"软件问题报告"人员的姓名、地址、电话。

7 问题属于什么方面

区分是程序的问题，还是模块的问题，或是数据库的问题，文件的问题。也可能是它们的某种组合。

8 模块/子系统

出现的模块名。如果不知是哪个模块，可标出子系统名，尽量给出细节。

9 修订版本号

出现问题的模块版本。

10 磁带

包含有问题的模块的主程序库的磁带的标识符。

11 数据库

当发现问题时所使用数据库的标识符。

12 文件号

有错误的文件的编号。

13 测试用例

发现错误时所使用测试用例的标识符。

14 硬件

发现错误时所使用的计算机系统的标识。

15 问题描述/影响

问题症兆的详细描述。如果可能，则写明实际问题所在。也要给出该问题对将来测试、接口软件和文件等的影响。

16 附注

记载补充信息。

13软件修改报告

1 登记号

由软件配置管理部门为该报告规定的编号。

2 登记日期

软件配置管理部门登记"软件修改报告"的日期。

3 时间

准备好"软件修改报告"的日期。

4 报告人

填写该报告的作者。

5 子系统名

受修改影响的子系统名。

6 模块名

被修改的模块名。

7 "软件问题报告"的编号

被"软件修改报告"处理或部分处理的"软件问题报告"的编号。如果某"软件问题报告"的问题只是部分被处理，则在编号后附以p，如1234p。

8 修改

包括程序修改、文件更新、数据库修改或它们的组合。

9 修改描述

修改的详细描述。如果是文件更新或数据库修改，还要列出文件更新通知或数据库修改申请的标识符。

10 批准人

批准人签字，正式批准进行修改。

11 语句类型

程序修改中涉及到的语句类型，包括：输入/输出语句类、计算语句类、逻辑控制语句类、数据处理语句类（如数据传送、存取语句类）。

12 程序名

被修改的程序、文件或数据库的名字。

13 老修订版

当前的版本/修订本标识。

14 新修订版

修改后的版本/修订本标识。

15 数据库

如果申请数据库修改，则给出数据库的标识符。

16 数据库修改报告

数据库修改申请号。

17 文件

如果要求对文件进行修改，则给出文件的名字。

18 文件更新

文件更新通知单的编号。

19 修改是否已测试

指出已对修改做了哪些测试，如单元、子系统、组装、确认和运行测试等，并注明测试成功与否。

20 "软件问题报告"是否给出问题的准确描述

回答'是'或'否'。

21 问题注释

准确地叙述要维护的问题。

22 问题源

指明问题来自于哪里，如软件需求说明书、设计说明书、数据库、源程序等。

23 资源

完成修改所需资源的估计，即总的人时数和计算机时间的开销。

(国内标准)GB-软件开发主要文档编写规范

231 GB 8567－88软件开发主要文档编写规范 本附录中列出了《计算机软件产品开发文件编制指南》GB 8567－88中主要软件文档的编写说明，供编写时参考。这些文档主要是：可行性研究报告、项目开发计划、软件需求说明书、概要设计说明书、详细设计说明书、模块开发卷宗、测试计划、测试分析报告、项目开发总结报告。 一、可行性研究报告 l 引言 1.1 编写目的 说明：说明本可行性研究报告的编写目的，指出预期的读者。 1.2 背景 说明： a ．所建议开发的软件系统的名称。 b ．本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络。 c ．该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3 定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4 参考资料 列出用得着的参考资料，如： a ．本项目的经核准的计划任务书或合同、上级机关的批文。 b ．属干本项目的其他已发表的文件。 c. 本文件中各处引用的文件、资料，包括所需用到的软件开发标准。 列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2 可行性研究的前提 说明对建议开发项目进行可行性研究的前提，如要求、目标、条件、假定和限制等。 2.1 要求 说明对所建议开发软件的基本要求，如： a ．功能。 b ．性能。 c ．输出如报告、文件或数据，对每项输出要说明其特征，如用途、产生频度、接口以及分发对象。 d. 输入说明。系统的输入包括数据的来源、类型、数量、数据的组织以及提供的频度。 e ．处理流程和数据流程。用图表的方式表示出最基本的数据流程和处理流程，并输之以叙述。 f. 在安全与保密方面的要求。 g. 同本系统相连接的其他系统。 h. 完成期限。 2.2 目标 说明所建议系统的主要开发目标，如： a. 人力与设备费用的减少。 b. 处理速度的提高。 c. 控制精度或生产能力的提高。

软件开发 软件产品开发文件编制指南

附录五国家标准《计算机软件产品开发文件编制指南》国家标准《计算机软件产品开发文件编制指南》（GB 8567—88）是一份指导性文件。它建议在软件的开发过程申编下述14个文件：可行性研究报告、项目开发计划、软件需求说明书、数据要求说明书、总体设计说明书、详细设计说明、数据库设计说明书、用户手册、操作手册、模块开发卷、测试计划、测试分析报告、开发进度表、项目开发总结。该指南给出了这14个文件的编制提示，它同时也是这14个文件编写质量的检验准则。下面详细介绍这14种文件的编写目的与内容要求。 l、可行性研究报告 可行性研究报告的目的是：说明该软件开发项目的实现在技术上、经济上和社会条上的可行性，论述为了合理地达到开发目标而可能选择的各种方案，说明并论证所选定的方案。可行性研究报告的编写内容见表l。 表l 可行性研究报告 2、项目开发计划 编制项目开发计划的目的是用文件的形式，并在开发过程中各项工作的

负责人员、开发进度、经费预算、所需软硬件条件等问题做出的安排记录下来，以便根据本计划开展和检查项目的开发工作。编制内容要求如表2所示。 表 2 项目开发计划 3、软件需求说明书 软件需求说明书的编制是为了使用户和软件开发人员双方对该软件的初始规定有一个共同的理解， 使之成为整个软件开发工作的基础。其内容要求见表3。 表3 软件需求说明书 4、数据要求说明书 数据要求说明书的编制目的是为了向整个软件开发时期提供关于被处理数据的描述和数据采集要求的技术信息，其内容要求列于表4中。 表4 数据要求说明书

5、概要设计说明书 概要设计说明书又称为总体设计说明书，编制目的是说明对项目系统的设计考虑，包括基本处理流程、组织结构、模块结构、功能配置、接口设计、运行设计、系统配置、数据结构设计和出错处理设计等，为程序的详细设计提供基础。其内容要求见表5。 表5 概要设计说明书 6、详细设计说明书 详细设计说明书又称为程序设计说明，编制目的是说明一个软件系统各个层次中的每一个程序（模块）的设计考虑。 如果软件系统比较简单，层次少，本文件可以不单独编写，有关内容可并入概要设计说明书。详细设计说明书的内容要求见表6。 表6 详细设计说明书 7、数据库设计说明书

软件开发文档规范

附2: 软件文档编写向导 文档分类 项目包括如下几类文档： 项目管理文档。包括：《软件项目计划》、《项目进度报告》、《项目开发总结报告》 软件开发文档。包括：《需求规格说明》、《概要设计说明》、《详细设计说明》、《测试计划》、《软件测试分析报告》。 产品文档。包括：《用户操作手册》《演示文件》。 软件项目计划 （Software Project Plan） 一?引言 1?编写目的（阐明编写软件计划的目的，指出读者对象。） 2?项目背景（可包括：（1 ）项目委托单位、开发单位和主管部门；（2）该软件系统与 其他系统的关系。） 3?定义（列出本文档中用到的专门术语的定义和缩略词的原文。） 4?参考资料（可包括：文档所引用的资料、规范等；列出资料的作者、标题、编号、发 表日期、出版单位或资料来源。） 二?项目概述 1.工作内容（简要说明项目的各项主要工作，介绍所开发软件的功能性能等?若不编写可行性研究报告，则应在本节给出较详细的介绍。） 2.条件与限制（阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的 条件?必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。） 3.产品 （1）程序（列出应交付的程序名称使用的语言及存储形式。） （2）文档（列出应交付的文档。） （3 ）运行环境（应包括硬件环境软件环境。） 4?服务（阐明开发单位可向用户提供的服务?如人员培训安装保修维护和其他运行支持。 5.验收标准

三.实施计划 1.任务分解（任务的划分及各项任务的负责人。） 2?进度（按阶段完成的项目，用图表说明开始时间完成时间。） 3?预算 4?关键问题（说明可能影响项目的关键问题，如设备条件技术难点或其他风险因素，并说明对策。） 四.人员组织及分工 五.交付期限 六.专题计划要点（如测试计划等。） 项目开发进度报告 一.报告时间及所处的开发阶段 二.给出进度 1.本周的主要活动 2.实际进展与计划比较 三.所用工时（按不同层次人员分别计时。） 四.所有机时 五.工作遇到的问题及采取的对策 六.本周完成的成果 七.下周的工作计划 八.特殊问题 项目开发总结报告 一.引言 1.编写目的（阐明编写总结报告的目的，指明读者对象。） 2.项目背景（说明项目的来源、委托单位、开发单位及主管部门。） 3.定义（列出报告中用到的专门术语定义和缩写词的原意。） 4.参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括： （1 ）项目开发计划；（2 ）需求规格说明书；（3 ）概要设计说明书；（4 ）详细设计说明

ISO软件开发全套文档~软件开发过程控制程序

北京易游无限科技公司 https://www.wendangku.net/doc/da1304421.html, EUWX/QP 0714 软件开发过程控制控制程序 授控状态： 版号：A/O 分发号： 持有人： 2007年8月6日发布2007年8月6日实施

易游无限科技发布 易游无限科技程序文件文件编号CSI/QP 0714 版号A/0 标题: 软件开发过程控制程序页码共5页第1页

为保证软件产品及其文档可维护，软件开发过程得到有效控制，特制定本程序。 2适用范围 本程序文件适用于本公司有合同的所有软件开发过程的控制活动。 3定义 3．1需求分析：（引用GB/T11457-1995的2.404）研究用户要求以得到系统或软件需求定义的过程。 3．2概要设计：（引用GB/T11457-1995的2.343）分析各种设计方案和定义软件体系结构的过程。典型的概要设计包括计算机程序组成成分和数据的定义及构造、界面的定义，并提出时间和规模方面的估计。 3．3详细设计：（引用GB/T11457-1995的2.147）推敲并扩充概要设计，以获得关于处理逻辑、数据结构和数据定义的更加详尽的描述，直到设计完善到足以能实现的地步。 3．4设计实现：（引用GB/T11457-1995的2.229）把设计翻译成代码，然后对此代码排除隐错的过程。它是程序的一种机器可执行形式，或者能被自动地翻译成机器可执行的形式的某种形式的程序。 4职责 4．1项目负责人：负责制订《项目计划》、协调项目内外各方的关系、控制项目进度并保证项目计划的实施和完成。 4．2需求分析员：作为开发方的代表，负责沟通用户和开发人员的认识和见解，明确及准确地编写《软件需求说明书》和初步的《系统指南》。 4．3系统设计员：负责把软件需求变换成可表示的可实现的软件形式，为设计实现提供可行的依据。并在设计过程中要负责编写《概要设计说明书》、《数据库设计说明书》、《详细设计说明书》，完成《系统指南》的编写。 4．4程序员：按设计要求把软件的详细设计变换成可执行的源程序，进行调试。完成相应的文档，编写《用户操作手册》。 4．5测试人员：负责制定测试计划，设计测试方案，测试用例，并实施测试。 4．6配置管理人员负责对开发库中软件配置项的管理和维护。 4工作程序 软件开发过程主要分为项目计划、需求分析、概要设计、详细设计、设计实现、内部测试和系统测试7个阶段。 易游无限科技程序文件文件编号CSI/QP 0714 版号A/0 标题: 软件开发过程控制程序页码共5页第2页

计算机软件文档编制规范

《计算机软件文档编写指南》 一．计算机软件文档由封面、目录、正文、注释和附录组成。 封面格式： 密级：编号： 文档名称： 项目名称： 编制： 审核： 批准： ×××××××××××××研究所 年月日

二．计算机软件文档包括： 1）软件开发计划 2）软件需求规格说明 3）接口需求规格说明 4）接口设计文档 5）软件设计文档 6）软件产品规格说明 7）版本说明文档 8）软件测试计划 9）软件测试说明 10）软件测试报告 11）计算机系统操作员手册 12）软件用户手册 13）软件程序员手册 14）计算机资源综合保障文件 软件开发计划 一．引言 1．编写目的（阐明编写软件计划的目的，指出读者对象。） 2．项目背景（可包括：（1）项目委托单位、开发单位和主管部门；（2）该软件系统与其他系统的关系。） 3．定义（列出本文档中用到的专门术语的定义和缩略词的原文。） 4．参考资料（可包括：（1）项目经核准的计划任务书、合同或上级机关的批文；（2）文档所引用的资料、规范等；列出资料的作者、标题、编号、发表日期、出版单位或资料来源。）二．项目概述 1.工作内容（简要说明项目的各项主要工作,介绍所开发软件的功能性能等. 若不编写可行 性研究报告,则应在本节给出较详细的介绍。) 2.条件与限制（阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的条件. 必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。） 3.产品 （1）程序（列出应交付的程序名称使用的语言及存储形式。） （2）文档（列出应交付的文档。） （3）运行环境（应包括硬件环境软件环境。） 4．服务（阐明开发单位可向用户提供的服务. 如人员培训安装保修维护和其他运行支持。）

软件开发过程管理规范

软件开发过程管理规范文件管理序列号：[K8UY-K9IO69-O6M243-OL889-F88688]

0 引言 如果要提高软件开发人员的开发质量，必须有相应的考核制度，有了制度后才能推动开发人员想方设法改善自已的开发质量。目前研发对软件开发的过程缺乏细粒度的度量，所以不能依据有效的度量数据来考核开发人员的工作绩效，大部份只是凭考核人主观意志来考核，不能形成对被考核人有效的说服力。此绩效考核办法旨在结合实际情况合理客观地评价开发效率和质量。 1 目的 对软件开发的过程所产生的软件项的质量和过程进行定量的评价，用评价的结果指导软件的开发过程，不断地提高软件开发质量水平，并依据度量记录来考核软件开发人员的工作绩效。 2 软件项包括 1）技术文档：主要包括：可行性分析报告、需求分析报告、软件功能规格说明、开发计划、系统设计报告、测试文档、用户手册、总结报告等； 2）计算机程序。 3 度量数据的来源 1）项目计划； 2）评审报告； 3）测试报告； 4）问题报告； 5）软件维护记录； 4 质量度量

4.1 度量指标 主要根据各类软件项检查表的检查指标来确定，例如，软件需求规格说明书检查表（见附录1），有10个检查指标，则根据具体项目检查侧重点不同，可从中选择相应的检查指标作为度量指标。 4.2 质量等级 1）软件项的质量等级的确定根据度量综合指标进行。 2）度量综合指标计算公式为：Total = ∑QiMi。 3）其中i=1,2,...n代表指标数量； 4）Q代表度量的指标； 5）M代表度量的指标Q在整个指标体系中所占的权重系数，对不同的开发项目可能不同，此系数根据开发的不同着重点给出。 度量指标权重系数表： 序号指标权重 1 指标1 权数1 2 指标2 权数2 3 指标3 权数3 4 指标4 权数4 5 指标5 权数5 加权平均分 1.0 6）质量评价：一般地，根据度量综合指标值，有以下评分标准。 质量评价计分标准表 序号得分质量评价

软件项目开发计划规范

软件项目开发计划规范 1 引言 1.1编写目的 ? 阐明开发本软件的目的； ? 说明编写这份项目开发计划的目的； ? 指明软件需求说明书所预期的读者。 1.2背景 ? 表示待开发的软件系统的名称、代码； ? 列出本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络； ? C.说明该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4参考资料 列出用得着的参考资料，如： a．本项目的经核准的计划任务书或合同、上级机关的批文； b．属于本项目的其他已发表的文件； c．本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2 项目概述 2.1 工作内容 简要地说明在本项目的开发中须进行的各项主要工作。 2.2主要参加人员 扼要说明参加本项目开发工作的主要人员的情况，包括他们的技术水平。 2.3产品 2.3.1程序 列出需移交给用户的程序的名称、所用的编程语言及存储程序的媒体形式，并通过引用有关文件，逐项说明其功能和能力。 2.3.2文件 列出需移交给用户的每种文件的名称及内容要点。 2.3.3服务 列出需向用户提供的各项服务，如培训安装、维护和运行支持等，应逐项规定开始日期、所提供支持的级别和服务的期限。 2.3.4非移交的产品 说明开发集体应向本单位交出但不必向用户移交的产品（文件甚至某些程序）。 2.4验收标准 对于上述这些应交出的产品和服务，逐项说明或引用资料说明验收标准。 2.5完成项目的员迟用限 2.6本计划的批准者和批准日期 3实施计划 3.1工作任务的分门与人员分工

软件开发文档模板库

软件开发文档模板库 1 可行性研究报告 可行性研究报告的编写目的是：说明该软件开发项目的实现在技术、经济和社会条件方面的可行性；评述为了合理地达到开发目标而可能先择的各种方案；说明论证所选定的方案。 可行性研究报告的编写内容要求如下： 1.1 引言 1.1.1 编写目的 1.1.2 背景 1.1.3 定义 1.1.4 参考资料 1.2 可行性研究的前提 1.2.1 要求 1.2.2 目标 1.2.3 条件、假定和限制 1.2.4 进行可行性研究的方法 1.2.5 评价尺度 1.3 对现有系统的分析 1.3.1 数据流程和处理流程 1.3.2 工作负荷 1.3.3 费用开支 1.3.4 人员 1.3.5 设备 1.3.6 局限性 1.4 所建议的系统 1.4.1 对所建议系统的说明 1.4.2 数据流程各处理流程 1.4.3 改进之处 1.4.4 影响 1.4.4.1 对象设备的影响 1.4.4.2 对软件的影响 1.4.4.3 对用户单位机构的影响 1.4.4.4 对系统动行的影响 1.4.4.5 对开发的影响 1.4.4.6 对地点和设施的影响 1.4.4.7 对经费开支的影响 1.4.5 局限性 1.4.6 技术条件方面的可行性 1.5 可选择其他系统方案 1.5.1 可选择的系统方案1

1.5.2 可选择的系统方案2 …… 1.6 投资及收益分析 1.6.1 支出 1.6.1.1 基本建设投资 1.6.1.2 其他一次性支出 1.6.1.3 非一次性支出 1.6.2 收益 1.6. 2.1 一次性收益 1.6. 2.2 非一次性收益 1.6. 2.3 不可定量的收益 1.6.3 收益/投资比 1.6.4 投资回收周期 1.6.5 敏感性分析 1.7 社会条件方面的可行性 1.7.1 法律方面的可行性 1.7.2 使用方面的可行性 1.8 结论 2 项目开发计划 编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度所需经费预算、所需软、硬件条件等问题作出安排记载下来，以便根据本计划开展和检查本项目的开发工作。编制内容要求如下： 2.1 引言 2.1.1 编写目的 2.1.2 背景 2.1.3 定义 2.1.4 参考资料 2.2 项目概述 2.2.1 工作内容 2.2.2 主要参加人员 2.2.3 产品及成果 2.2. 3.1 程序 2.2. 3.2 文件 2.2. 3.3 服务 2.2. 3.4 非移交产品 2.2.4 验收标准 2.2.5 完成项目的最迟期限 2.2.6 本计划的审查者与批准者 2.3 实施总计划 2.3.1 工作任务的分解 2.3.2 接口人员 2.3.3 进度 2.3.4 预算 2.3.5 关键问题

软件研发管理制度

武汉新英赛研发管理 第一节 软件研发岗位职责 一、软件研发部经理岗位职责 软件研发部经理在总经理或主管副总的领导下, 全面负责软件研发部的日常管理， 组织 开展软件研发与测试工作，完成企业研发目标和经营目标。其具体职责如表 二、高级研发工程师岗位职责 高级研发工程师参与建立研发工作标准与规范，协助部门经理组织完成软件研发工作, 管理软件研发项目，改良升级进行软件。其具体职责如表 8-1所示。 8-2所示。

表8-2 高级研发工程师岗位职责 三、软件研发工程师岗位职责 软件研发工程师协助高级工程师进行软件的设计与开发，收集整理相关行业信息与资料，为软件产品决策提供依据。其具体职责如表8-3所示。

四、软件测试工程师岗位职责 软件测试工程师主要负责软件测试工作, 根据软件产品规格和测试需求，编写测试方案、测试用例、测试脚本软件等。其具体职责如表8-4所示。 第二节软件研发管理制度 六、软件研发费用管理制度 第1章总则 第1条目的。 为了加强软件研发费用管理，规范资金的使用，减少公司不必要的损失，根据公司的实

际情况，特制定本制度。 第2 条研发费用管理原则。 1．计划统筹安排原则。 2．节约使用、讲求经济效益原则。 第3 条职责分工。 1．公司财务部负责研发费用的审批和报销，并随时监督费用的使用情况。 2．软件研发部负责研发费用的预算与使用控制。 第2 章研发费用的来源及使用范围 第4 条研发费用的来源。 1．公司对重点研发产品的专项拨款。 2．公司成本列支的研发费用。 3．从其他方面筹措来用于研发的费用。 第5 条研发费用的使用范围。 1．研发活动直接消耗的材料、燃料和动力费用。 2．研发人员的工资、奖金、社会保险费、住房公积金等人工费用以及外聘研发人员的劳务费用。 3．用于研发活动的仪器、设备、房屋等固定资产的折旧费或租赁费以及相关固定资产的运行维护、维修等费用。 4．用于研发活动的软件、专利权、非专利技术等无形资产的摊销费用。 5．用于中间试验和产品试制的模具、工艺装备开发及制造费，设备调整及检验费，样品、样机及一般测试手段的购置费，试制产品的检验费等。 用。用。6．研发成果的论证、评审、验收、评估以及知识产权的申请费、注册费、代理费等费7．通过外包、合作研发等方式，委托其他单位、个人或与之合作进行研发而支付的费8．与研发活动直接相关的其他费用，包括技术图书资料费、资料翻译费、会议费、差 旅费、办公费、外事费、研发人员培训费、专家咨询费、高新科技研发保险费用等。 第3章研发费用的使用管理 第6 条专款专用。

ISO软件开发全套文档-配置管理计划编写指南

产品/项目系统名称 配置管理计划 北京XXXX有限公司 200 年××月 1引言 1.1编写目的

编写的目的主要在于对所开发的软件系统规定各种必要的配置管理条款，以保证所开发出的软件能满足用户需求。 1.2背景 a.开发的软件系统的名称 列出本软件系统的中文全称、英文全称及英文表示简称。 b.开发的软件系统的最终用户或适用的领域； c.项目来源、主管部门等 1.3定义 列出本文件中涉及的专门术语定义和外文缩写的原词组。 1.4参考资料 列出涉及的参考资料。 2 管理 描述软件配置管理的机构、任务、职责和有关的接口控制。 2.1 机构 描述软件生存周期中各阶段中软件配置管理的功能和负责软件配置管理的机构。 说明项目和自项目与其他有关项目之间的关系。 指出在软件生存周期各阶段中的软件开发或维护机构与配置控制组的关系。 2.2 任务 描述在软件生存周期中各阶段的配置管理任务以及要进行的评审和检查工作，并指出各阶段的阶段产品应存放在哪一类软件库中（软件开发库、软件受控制库或软件产品库）。 2.3 职责 指出负责各项软件配置管理任务（如配置标识、配置控制、配置状态记录以及配置的评审与检查）的机构的职责； 指出上述机构与软件质量保证机构、软件开发单位、项目承办单位、项目委托单位以及用户等机构的关系。 说明软件生存周期各个阶段的评审、检查和审批过程中的用户职责以及相关的开发与维护活动。 指出与项目开发有关的各机构的代表的软件配置管理职责。 指出与其他特殊职责，例如为满足软件配置管理要求所必要的批准要求。 2.4 定义软件配置项（SCI） 包括： 1．系统约定 2．软件项目计划 3．软件需求文档 4．用户手册 5．设计文档

软件开发与维护管理规范

软件开发与维护管理规范 1 目的通过规范软件的开发与维护过程，达到提高软件质量，降低维护成本的目的。 2 范围适用于新产品的软件开发设计以及定型产品的改进升级。 3 职责与权限 研发中心负责： a)编制软件开发过程的实施、协调和控制工作； b)编制各阶段的技术文件； c)组织软件的测试、验收、升级和维护工作。 各部门参与软件开发过程中有关的设计评审。 4 内容 软件项目的开发实施过程管理要求 软件项目实施过程总体要求 本部分主要要求工程师制定软件开发工作计划，对过程进行控制，一般包括以下的内容。a) 工程师提交软件开发工作大纲，项目组织者对工作大纲进行评审，并提出整改意见。 b)通过评审后，工程师根据整改意见完善工作大纲，经过项目经理认可后组织项目组进行 软件开发。软件开发工作按照需求分析、概要设计、详细设计、编码、测试等几个阶段进行，在开发过程中，工程师需分阶段提交相关文档。 c)在软件开发工作完成后，工程师应向项目组提交完整的软件文档，相关人员组织验收组对软件进行验收审查。 软件项目实施变更要求在开发过程中，需求或设计不可避免地需要发生变更，相关变更必须提交《软件变更申请》经过项目组书面同意方可进行。在需求或设计发生变更时，需要对原有文档进行修改，并提供完整的变更记录，以使变更处于可控制的状态。 软件项目实施里程碑控制本部分主要对软件开发过程中的重要节点进行控制。项目组将分四个阶段进行把关，召开审查会。 a）需求分析（结合原型进行审查）确认；

b）概要设计+数据库设计； c）预验收（样机测试时）； d）正式验收（产品定型后）。 软件开发 软件开发必须严格按照软件工程的要求进行。开发过程包括工程师的活动和任务。此过程由软件需求分析、概要设计、详细设计、编码、测试、验收、鉴定等活动组成。 软件的需求分析 需求分析 需求分析要求开发人员准确理解用户的需求，进行细致的调查分析，将用户非形式的需求陈述转化为完整的需求定义，再由需求定义转化到相应的形式功能规约《软件需求规格说明书》的过程。 在《软件需求规格说明书》必须描述的基本问题是：功能、性能、强加于实现的设计限制、属性、外部接口。 需求报告评审在软件需求分析工作完成后，软件工程师应向项目组提交《软件需求规格说明书》。项目组组织有关人员（系统客户和系统开发人员等）对需求进行评审，以决定软件需求是否完善和恰当。项目组严格验证这些需求的正确性，一般从一致性，完整性，现实性，有效性四个方面进行验证。评审完成后，就可以进入软件的设计阶段。 软件的概要设计 概要设计 概要设计也称为系统设计，需要确定软件的总体结构，应该由哪些模块组成，以及模块与模块之间的接口关系，软件系统主要的数据结构和出错处理设计等，同时还要制定测试方案，形成概要设计说明书，为软件的详细设计提供基础。在概要设计时一般从以下几方面来考虑，遵循以下的流程。 概要设计和需求分析、详细设计之间的关系和区别需求分析不涉及具体的技术实现，而概要设计注重于从宏观上和框架上来描述采用何种技术手段、方法来实现这些需求。详细设计相对概要设计更注重于微观上和框架内的设计，是编码的依据。概要设计是指导详细设计的依据。 概要设计的评审 在软件概要设计工作完成后，软件工程师应向项目组提交《软件概要设计》。评审通过后，即可进入详细设

软件开发技术文档编写规范

软件开发技术文档编写规范 在项目开发过程中，应该按要求编写好十三种文档，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。 ◇可行性分析报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。 ◇项目开发计划：为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。 ◇软件需求说明书（软件规格说明书）：对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。 ◇概要设计说明书：该说明书是概要实际阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计提供基础。 ◇详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。 ◇用户操作手册：本手册详细描述软件的功能、性能和用户界面，使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。 ◇测试计划：为做好集成测试和验收测试，需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。 ◇测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。 ◇开发进度月报：该月报系软件人员按月向管理部门提交的项目进展情况报告，报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。 ◇项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对开发工作做出评价，总结出经验和教训。 ◇软件维护手册：主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明，便于软件的维护。 ◇软件问题报告：指出软件问题的登记情况，如日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。 ◇软件修改报告：软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。 1可行性分析报告 1 引言 1.1 编写目的：阐明编写可行性研究报告的目的，提出读者对象。

软件开发设计文档模板

软件文档编写指南 封面格式： 文档编号 版本号 文档名称： 项目名称： 项目负责人： 编写年月日 校对年月日 审核年月日 批准年月日 开发单位 系统规约说明书（System Specification） 一．引言 A.文档的范围和目的 B.概述 1．目标 2．约束 二．功能和数据描述 A.系统结构 1．结构关系图 2．结构关系图描述 三．子系统描述 A.子系统N的结构图规约说明 B.结构字典 C.结构连接图和说明 四．系统建模和模拟结构 A.用于模拟的系统模型

B.模拟结果 C.特殊性能 五．软件项目问题 A.软件项目可行性研究报告 B.软件项目计划 六．附录 软件项目可行性研究报告（Report for Feasibility Study） 一．引言 1．编写目的（阐明编写可行性研究报告的目的，指出读者对象） 2．项目背景（应包括：（1）所建议开发的软件名称；（2）项目的任务提出者、开发者、用户及实现单位；（3）项目与其他软件或其他系统的关系。） 3．定义（列出文档中用到的专门术语的定义和缩略词的原文。） 4．参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。）二．可行性研究的前提 1．要求（列出并说明建议开发软件的基本要求，如（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．决定可行性的主要因素 三．对现有系统的分析 1．处理流程和数据流程 2．工作负荷 3．费用支出（如人力、设备、空间、支持性服务、材料等项开支。） 4．人员（列出所需人员的专业技术类别和数量。） 5．设备 6．局限性（说明现有系统存在的问题以及为什么需要开发新的系统。） 四．所建议技术可行性分析 1．对系统的简要描述 2．处理流程和数据流程 3．与现有系统比较的优越性 4．采用建议系统可能带来的影响 （1）对设备的影响 （2）对现有软件的影响

软件开发文档样式规范

文档编号：_________ _________ 文档名称：____________ 项目名称：____________ 项目负责人：____________ 编写：___________ ____年__月__日

校对：___________ ____年__月__日审核：___________ ____年__月__日批准：___________ ____年__月__日 开发单位：广东传讯网络信息有限公司________________________ 系统规格说明

一、系统功能和目标： 随着因特网的不断普及，国内的用户数呈指数级增长。作为因特网最为常用的电子邮件系统越来越受到人们的喜爱，为了满足不断增长的信息交换的需要，各行各业都希望有自己的邮件系统。广东传讯网络信息有限公司自主设计开发了适合中国国情的免费电子邮件系统，用以解决这一日益突出的问题。CHINATION免费电子邮件系统是专为免费电子邮件服务商、企业集团设计的电子邮件系统。 Chination免费电子邮件系统的设计目标是立足于一个高度集成的、功能强大、技术先进的电子邮件系统。高度集成意味着本系统将把硬盘软件集成在一起。系统是基于LINUX下的，硬盘和软件的集成使得系统具有绝对的安装优势。功能强大意味着系统的实用性，功能的全面性，系统的安全性和可靠性。技术先进意味着将最新版本的LDAP，IMAP，POSTFIX，MYSQL，APACHE 和PHP的巧妙结合。 本系统要实现的主要功能有： 1．用户申请注册功能。用户通过申请可以得到一个自己命名的信箱，容量大小为10M。 2．用户忘记密码处理功能。用户忘记密码可以通过注册时设置的密码提示问题来重设密码。 3．用户收邮件功能。它包括SMTP收邮件、POP3取邮件和WWW读邮件三种方式。 4．用户发邮件功能。它包括SMTP发邮件、WWW直接发送邮件、暗送邮件、抄送邮件、定时发送邮件。 5．用户信件处理功能。系统初始设置4个文件夹来分类处理信件：收件箱、发件箱、草稿箱和垃圾箱。用户还可以自己建立新的文件夹。信件在各个信箱之间可以相互移动。 6．用户查找功能。用户可以使用查找功能通过查找信件主题或信件内容来找到自己需要的信件。 7．用户信箱配置设置。它包括个人资料更改、密码更改、参数设置、POP3服务器设置、过滤器设置、自动转信、定时发信、签名设置。 8．管理员管理用户和信箱邮件功能。包括输入（增删改）、查询、统计、报表。系统性能参数设置。 9．广播功能。它用于公司定期向一定的用户发送信息，由于一般的用户数有一定数量，所以必须用数据库管。 二、可行性分析 1．技术可行性 本软件拟决定最终在分布式系统上来运行。硬件方面，由于广东传讯网络信息有限公司是国外多

GB 16680-1996 软件文档管理指南

GB/16680－1996软件文档管理指南 1 范围 本标准为那些对软件或基于软件的产品的开发负有职责的管理者提供软件文档的管理指南。本标准的目的在于协助管理者在他们的机构中产生有效的文档。 本标准涉及策略、标准、规程、资源和计划，管理者必须关注这些内容，以便有效地管理软件文档。 本标准期望应用于各种类型的软件，从简单的程序到复杂的软件系统。并期望覆盖各种类型的软件文档，作用于软件生存期的各个阶段。 不论项目的大小，软件文档管理的原则是一致的。对于小项目，可以不采用本标准中规定的有关细节。管理者可剪裁这些内容以满足他们的特殊需要。 本标准是针对文档编制管理而提出的，不涉及软件文档的内容和编排。 2 引用标准 下列标准所包含的条文，通过在本标准中引用而构成为本标准的条文。本标准出版时，所示版本均为有效，所有标准都会被修订，使用本标准的各方应探讨使用下列标准最新版本的可能性。 GB 8566-88 计算机软件开发规范 GB 8567-88 计算机软件产品开发文件编制指南 GB/T 11457-1995 软件工程术语 3 定义 本标准采用下列定义，其他定义见 GB/T 11457 。 3.1 文档 document 一种数据媒体和其上所记录的数据。它具有永久性并可以由人或机器阅读。通常仅用于描述人工可读的内容。例如，技术文件、设计文件、版本说明文件。 3.2 文档（集）；文档编制 documentation 一个或多个相关文档的集合。 3.3 文档计划 documentation plan 一个描述文档编制工作方法的管理用文档。该计划主要描述要编制什么类型的文档，这些文档的内容是什么，何时编写，由谁编写，如何编写，以及什么是影响期望结果的可用资源和外界因素。 3.4 文档等级 level of documentation 对所需文档的一个说明，它指出文档的范围、内容、格式及质量，可以根据项目、费用、预期用途、作用范围或其他因素选择文档等级。 3.5 软件产品 software product 软件开发过程的结果，并推出供用户使用的软件实体。 4 软件文档的作用 a) 管理依据； b) 任务之间联系的凭证； c) 质量保证； d) 培训与参考； e) 软件维护支持； f) 历史档案。 4.1 管理依据 在软件开过过程中，管理者必须了解开发进度、存在的问题和预期目标。每一阶段计划安排的定期报告提供了项目的可见性。定期报告还提醒各级管理者注意该部门对项目承担的

软件开发规范标准整体规范标准

软件开发规范 Software Development Specification Version: V1.0 Date: 2010-06-22 Prepared by

Document Revision History文档修订记录

Table of Contents目录 1Introduction 简介5 1.1Purpose 目标5 1.2Scope 范围6 1.3Definitions, Acronyms, and Abbreviations. 术语，缩略词6 1.4References 引用7 1.5Overview 文档组织7 2The Overall Description 概述8 2.1Software Development Organizing 开发团队组织结构8 2.2Project Base Process 项目基本流程9 2.3CMM Base Process CMM基本过程10 2.3.1SCM软件配置管理10 2.3.2SPP 计划策划12 2.3.3SPTO项目追踪16 2.3.4PR同行评审18 2.3.5SQA质量保证19 2.4SDLC 生命周期选择20 2.5Development Process 开发过程21 2.5.1Development Phase 开发阶段21 2.5.2Phase Product 阶段制品22 2.6Role Duty 角色职责23 2.7Constraints 限制24 3Specific Requirements 详细描述25 3.1Precondition 前提25 3.1.1SCM配置库25 3.1.2Test Environment 测试环境26 3.2Development Control Process 开发控制流程26 3.2.1项目启动和策划阶段27 3.2.2需求分析、设计、编码阶段27 3.2.3提交测试阶段27 3.2.4生产发布、终测28 3.2.5发布后问题反馈修改过程28 3.3TSP 团队软件过程30 3.3.1会议组织30 3.3.2沟通问题30 3.3.3代码走查30

软件开发技术文档编写规范-Read

神州数码（中国）有限公司 秘级：内部保密文件仅限内部使用 概要设计说明书模板 （V1.2） 文档编号：DC-QG-23-01 文档名称：概要设计说明书编写：沙存孝编写日期：1999.7.16 审核：钱增祺审核日期：1999.7.16 神州数码（中国）有限公司

用户名称 神州数码（中国）有限公司 秘级： 项目名称 概要设计说明书 （版本号） 文档编号：项目名称： 编写：编写日期： 审核：审核日期： 神州数码（中国）有限公司[项目名称]项目组

文档修订记录

目录 第一章引言 (6) 第一节编写目的 (6) 1.1.1作用 (6) 1.1.2预期读者 (6) 第二节编写背景 (7) 1.2.1 系统名称及版本号 (7) 1.2.2 任务提出者 (7) 1.2.3 任务承接者及实施者 (7) 1.2.4 使用者 (7) 1.2.5 与其它系统的关系 (7) 第三节文档结构 (7) 第四节电子文档编写工具 (7) 第五节定义说明与符号规定 (8) 第六节参考资料 (9) 第二章系统概述 (9) 第一节系统目标 (9) 第二节设计原则 (9) 第三节运行环境 (9) 2.3.1 硬件平台 (9) 2.3.2 软件平台 (9) 2.3.3 网络体系结构 (10) 第四节应用软件整体结构概述 (10) 第五节关键技术 (10) 第三章数据库设计 (11) 第一节数据组织 (11) 3.1.1数据分布方式 (11) 3.1.2数据传输与通讯 (11) 3.1.3 历史数据管理 (11) 第二节实体集列表 (11) 第三节概念数据模型图 (12) 第四节数据量估计 (14) 第五节数据分布方案 (14) 第六节实体与基本表的对应关系 (14) 第七节物理数据模型图 (15) 第八节数据库系统介绍 (15) 第四章代码设计 (16) 第一节背景介绍 (16) 第二节编制说明 (16) 第三节代码表列表 (17)

4.2软件开发管理办法

软件开发管理办法 修订记录 版本编号修订日期主要修订摘要 审核记录 审核人员属于部门审核日期 第一章总则 第一条为规范公司的开发管理流程，使各开发项目的管理进行标准化管理，特制定本管理办法。 第二条本管理办法详细规定软件开发程的各个阶段及每一阶段的任务、要求、交付文件，使整个软件开发过程阶段清晰、要求明确、任务具体，实现软件开发过程的标准化。 第三条本管理办法适用于计算机的自主软件开发项目。适用对象：软件开发管理人员，软件开发人员，软件维护人员，系统管理人员。 第二章组织机构与职责 第四条软件开发管理人员职责： 第五条软件开发人员职责： 第六条软件维护人员职责： 第七条系统管理人员职责： 第三章软件开发环境管理 第八条软件建设环境根据项目不同的时期，需要搭建生产运行环境、系统测试环境、系统开发环境三种不同的软硬件网络环境，便于生产、开发、测试等工作的安全、顺畅的进行。 第九条生产环境为系统维护管理人间管理的范畴，是系统正式运行，提交给各业务科室的正式环境，包括系统运行的硬件、网络等设备和进行集群处理的软件系统。 第十条测试环境为测试人员提供功能测试、性能测试的运行环境，包括运行环境模拟、测试工具服务器、测试工具客户端。 第十一条开发环境为系统开发人员提供系统开发需要的软件硬件环境，包括数据库服务器、应用服务器、开发工具客户端。 第十二条生产环境、测试环境、开发环境都存在自己独立的数据库服务器、应用服务器、客户端。在开发环境完成内部测试后，提交发布版本到测试环境中，由专门的测试人

员进行集成测试和功能测试。并进行一定的压力性能测试。在测试环境通过的版本在发布到生产环境。 第十三条生产环境与测试环境、开发环境需要物理隔离，保障生产环境的安全。 第四章开发过程管理 第十四条项目开发流程根据软件工程的流程，分为可行性研究与计划、需求分析、总计设计、详细设计、代码开发、系统测试五个阶段。 第十五条可行性研究与计划 1实施要求 1.软件开发部分析人员进行市场调查与分析，确认软件的市场需求 2.在调查研究的基础上进行可行性研究，写出可行性报告 3.评审和审批，决定项目取消或继续 4.若项目可行，制订初步的软件开发计划，建立项目日志 5.根据市场环境、公司软硬件情况预测十大风险因素 2交付文档 1.可行性研究报告* 2.初步的软件开发计划 3.十大风险列表* 4.软件项目日志* 第十六条需求分析 1实施要求 1.调查被开发软件的环境 2.软件开发提出的需求进行分析并给出详细的功能定义 3.做出简单的用户原型，与用户共同研究，直到用户满意 4.对可利用的资源（计算机硬件、软件、人力等）进行估计，制定项目进度计划（可 有相应的缓冲时间） 5.制定详细的软件开发计划 6.测试人员制订质量控制计划和测试计划 7.编写初步的用户手册 8.进行需求方案评审 2交付文档 1.软件需求说明书 2.更新后的软件开发计划 3.项目进度计划 4.计划