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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 状态

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

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

7 问题属于什么方面

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

8 模块/子系统

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

9 修订版本号

出现问题的模块版本。

10 磁带

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

11 数据库

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

12 文件号

有错误的文件的编号。

13 测试用例

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

14 硬件

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

15 问题描述/影响

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

16 附注

记载补充信息。

13软件修改报告

1 登记号

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

2 登记日期

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

3 时间

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

4 报告人

填写该报告的作者。

受修改影响的子系统名。

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. 控制精度或生产能力的提高。

软件技术文档编写规范

目录 第一章引言 1 §1.1 目的 1 §1.2 文档约定 1 §1.3 预期读者和阅读建议 1 §1.4 产品的范围 1 §1.5 参考文献 1 第二章综合描叙 1 §2.1 产品的前景 1 §2.2 产品的功能 1 §2.3 用户类和特征 2 §2.4 运行环境 2 §2.5 设计和实现上的限制 2 §2.6 假设和依赖 2 第三章外部接口需求 2 §3.1 用户界面 2 §3.2 硬件接口 3 §3.3 软件接口 3 §3.4 通信接口 3 第四章系统特性 3 §4.1 说明和优先级 3 §4.2 激励响应序列 3 §4.3 功能需求 3 第五章其他非功能需求 3 §5.1 性能需求 3 §5.2 安全设施需求 4 §5.3 安全性需求 4 §5.4 软件质量属性 4 §5.5 业务规则 4 §5.6 用户文档 4 第六章其他需求 4 §6.1 词汇表 4 §6.2 分析模型 4 §6.3 待确定问题列表 5 第1章引言 引言提出了对软件需求规格说明的纵览，这有助于读者理解文档如何编写并且如何阅读和解释。 §1.1 目的 对产品进行定义，在该文档中详尽说明了这个产品的软件需求，包括修正或发行版本号。如果这个软件需求规格说明只与整个系统的一部分有关系，那么就只定义文档中说明的部分或子系统。 §1.2 文档约定

描述编写文档时所采用的标准或排版约定，包括正文风格、提示区或重要符号。例如，说明了高层需求的优先级是否可以被其所有细化的需求所继承，或者每个需求陈述是否都有其自身的优先级。 §1.3 预期读者和阅读建议 列举了软件需求规格说明所针对的不同读者，例如开发人员、项目经理、营销人员、用户、测试人员或文档的编写人员。描述了文档中剩余部分的内容及其组织结构。提出了最适合于每一类型读者阅读文档的建议。 §1.4 产品的范围 提供了对指定的软件及其目的的简短描述，包括利益和目标。把软件与企业目标或业务策略相联系。可以参考项目视图和范围文档而不是将其内容复制到这里。 §1.5 参考文献 列举了编写软件需求规格说明时所参考的资料或其它资源。这可能包括用户界面风格指导、合同、标准、系统需求规格说明、使用实例文档，或相关产品的软件需求规格说明。在这里应该给出详细的信息，包括标题名称、作者、版本号、日期、出版单位或资料来源，以方便读者查阅这些文献。 如： a．本项目的经核准的计划任务书或合同、上级机关的批文； b．属于本项目的其他已发表的文件； c．本文件中各处引用的文件、资料、包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 第2章综合描叙 这一部分概述了正在定义的产品以及它所运行的环境、使用产品的用户和已知的限制、假设和依赖。 §2.1 产品的前景 描述了软件需求规格说明中所定义的产品的背景和起源。说明了该产品是否是产品系列中的下一成员，是否是成熟产品所改进的下一代产品、是否是现有应用程序的替代品，或者是否是一个新型的、自含型产品。如果软件需求规格说明定义了大系统的一个组成部分，那么就要说明这部分软件是怎样与整个系统相关联的，并且要定义出两者之间的接口。 §2.2 产品的功能 概述了产品所具有的主要功能。其详细内容将在 d 中描述，所以在此只需要概略地总结，例如用列表的方法给出。很好地组织产品的功能，使每个读者都易于理解。用图形表示主要的需求分组以及它们之间的联系，例如数据流程图的顶层图或类图，都是有用的。 §2.3 用户类和特征 确定你觉得可能使用该产品的不同用户类并描述它们相关的特征（见第7 章）。有一些需求可能只与特定的用户类相关。将该产品的重要用户类与那些不太重要的用户类区分开。 §2.4 运行环境 描述了软件的运行环境，包括硬件平台、操作系统和版本，还有其它的软件组件或与其共存的应用程序。

软件项目开发计划书

软件项目开发计划书 Company Document number：WUUT-WUUY-WBBGB-BWYTT-1982GT

软件开发计划书 项目名称：图书管理系统 目录

1引言 编写目的 为了保证项目团队按时保质地完成项目目标，便于项目团队成员更好地了解项目情况，使项目工作开展的各个过程合理有序，有必要以文件化的形式，把对于在项目生命周期内的工作任务范围、各项工作的任务分解、项目团队组织结构、各团队成员的工作责任、团队内外沟通协作方式、开发进度、经费预算、项目内外环境条件、风险对策等内容以书面的方式描述出来，作为项目团队成员以及项目干系人之间的共识与约定，项目生命周期内的所有项目活动的行动基础，项目团队开展和检查项目工作的依据。 本项目开发计划用于从总体上指导图书管理系统项目顺利进行并最终得到通过评审的项目产品。本项目开发计划面向项目组全体成员。 背景 山西农业大学图书管理系统是由沈阳师范大学委托我们开发的大型管理系统，主要功能是实现图书馆的信息化管理，包括读者信息管理，书籍信息管理，借阅信息管理，管理者信息管理等功能。项目周期为六个月，项目背景规划如表所示。 表项目背景规划

图书管理系统是学校信息管理系统的一个重要组成部分，它需要学生基本信息系统提供学生的基本资料，因为很多情况下，图书证号和学生的学生证号是一样的，而且在图书管理中，需要知道学生所在的系别和班级等信息；另外，它还需要教职工信息系统提供基本资料，因为教职工当然也能在图书馆借阅图书。因此，在设计时可以和校园信息管理系统的其他系统使用同一个数据库管理系统，以便系统之间的信息交流和管理。 定义 专门术语： SQL SERVER:系统服务器所使用的数据库关系系统（DBMS）。 SQL：一种用于访问查询数据库的语言 事务流：数据进入模块后可能有多种路径进行处理。 主键：数据库表中的关键域。值互不相同。 外部主键：数据库表中与其他表主键关联的域。 ROLLBACK:数据库的错误恢复机制。 缩写： 系统：若未特别指出，统指本图书管理系统。 SQL：Structured Query Language(结构化查询语言)。 ATM：Asynchronous Transfer Mode (异步传输模式)。 UML：统一建模语言、是一套用来设计软件蓝图的标准建模语言，是一种从软件分析、设计到编写程序规范的标准化建模语言。

软件开发文档规范

附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 ）详细设计说明

软件开发文档范例

文档编号：_________ _________ 文档名称：____________ 项目名称：____________ 项目负责人：____________ 编写：___________ ____年__月__日 校对：___________ ____年__月__日 审核：___________ ____年__月__日 批准：___________ ____年__月__日

开发单位：传讯网络信息 ________________________ 系统规格说明 一、系统功能和目标： 随着因特网的不断普及，国的用户数呈指数级增长。作为因特网最为常用的电子系统越来越受到人们的喜爱，为了满足不断增长的信息交换的需要，各行各业都希望有自己的系统。传讯网络信息自主设计开发了适合中国国情的免费电子系统，用以解决这一日益突出的问题。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．技术可行性 本软件拟决定最终在分布式系统上来运行。硬件方面，由于传讯网络信息是国外多家公司并行处理产品的代理商，而且自己本身拥有ALPHA机等先进设备，所以有足够能力开发出先进的电子系统。软件方面，我们拟采用以下几种软件： 1）操作系统用LINUX。Linux作为一个优秀的网络操作系统，它的发行版本中集成了大量的网络应用软件，如Web服务器(apache)、Ftp服务器(wu-ftp)、服务器(sendmail+imap4)、SQL数据库(postgresql)等，可以快速的构建Intranet环境，并且也有精致的收发程序(metamail)和强大的Web 服务器端开发工具(PHP4)。当你配置好sendmail并激活imapd后，你的Linux用户都可以使用Outlook等客户端软件进行收发，只要通过将它们集中进行应用，便可以实现一个简单的Webmail 服务器的功能。但是随着自由软件的不断开发，要构架一个好的电子系统，就面临着软件选择是否适当、性能是否比别人好的问题。下面列出我们所使用的软件。 2）本系统壳软件用imap。有几种方法可以构造电子系统的壳：共享文件系统的策略，基于局域网的专用协议，X.400P7协议和因特网消息存取协议。而基于INTERNET的协议主要有：POP (Post Office Protocol), DMSP (Distributed Mail System Protocol), 和IMAP (Internet Message Access Protocol).POP是最原始，最为人们所知的一种。DMSP仅局限于一个简单应用——PCMAIL，它的优点主要在于对脱机状态操作的支持。IMAP不但继承了POP和DMSP的优点，而且超越了他们的缺点，提供了三种状态下对远程信箱的访问：在线、不连接和脱机状态。在脱机状态，可以发送到一个共享的服务器，但是客户并不是马上全部把它们COPY过去之后在服务器上删掉它们，

软件项目开发计划规范

软件项目开发计划规范 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工作任务的分门与人员分工

技术文档模板

输入文档名称 内部文件：[输入文件版本号] 颁布时间：[输入颁布时间]

目录 文件版本说明 (2) 参考资料 (2) 手册目的 (2) 声明 (2) 名词定义和缩略语说明 (2) 1 [输入第一章标题] (3) 1.1 [输入第一章第一节标题] (3) 1.1.1 [输入第一章第一节第一小节标题] (3) 1.1.2 [输入第一章第一节第二小节标题] (3) 1.2 [输入第一章第二节标题] (3) 2 [输入第二章标题] (4) 2.1 [输入第一章第一节标题] (4) 2.2 [输入第一章第二节标题] (5) 表格 表 1-1 [输入表格标题] (3) 表 1-2 [输入表格标题] (3) 图表 图1-1 [输入图片名称] (4) 图2-1 [输入图片名称] (4)

文件版本说明 表 1 版本说明 参考资料 1.[列出参考资料名称] 2.[列出参考资料名称，需增加参考资料项，请在行末回车] 手册目的 [请对撰写本手册目的进行适当描述] 声明 [对本文档内容进行声明] 名词定义和缩略语说明 表 2 名词定义及缩略语说明

1[输入第一章标题] [输入正文] 1.1 [输入第一章第一节标题] [输入正文] 1.1.1[输入第一章第一节第一小节标题] [输入正文] 表 1-2 [输入表格标题] 1.1.2[输入第一章第一节第二小节标题] [输入正文] 1.2 [输入第一章第二节标题] [输入正文]

图1-1 [输入图片名称] 2[输入第二章标题] [输入正文] 2.1 [输入第一章第一节标题] [输入正文] 图2-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 关键问题 2.4 支持条件 2.4.1 计算机系统支持 2.4.2 需要用户承担的工作 2.4.3 需由外单位提供的条件 2.5 专题计划要点

软件开发计划书

软件开发计划书项目名称：自由游戏平台

参与人员： 软件项目开发计划书自由游戏平台 目录： 1.引言 1.1编写目的 1.2编写背景 1.3定义 1.4参考资料 1.5系统动机 1.6标准.条件和约定 1.7编写文档的WBS 2.项目概述 2.1工作内容 2.2主要参加人员 2.3产品及成果 ①程序

②文件 ③服务 ④非移交产品 2.4验收标准 ①代码的验收 ②文档的验收 ③服务的验收 2.5完成项目的最迟期限 2.6本计划的审查者与批准者 3.实施总计划 3.1开发过程 ①需求分析 ②系统设计 ③编码及测试阶段 ④文档.产品部署 ⑤项目总结 3.2工作任务的分解 3.3接口人员 3.4进度 3.5预算 3.6关键问题 4.支持条件 4.1计算机系统支持 4.2需要用户承担的工作

4.3需由外单位提供的条件 5.专题计划要点 5.1开发人员培训计划 5.2测试计划 5.3质量保证计划 5.4人员配置计划 5.5客户培训计划 5.6安全保密计划

引言 编写目的: 为了保证项目团队按时保质地完成项目目标，便于项目团队成员更好地了解项目情况，使项目工作开展的各个过程合理有序，有必要以文件化的形式，把对于在项目生命周期内的工作任务范围、各项工作的任务分解、项目团队组织结构、各团队成员的工作责任、团队内外沟通协作方式、开发进度、经费预算、项目内外环境条件、风险对策等内容以书面的方式描述出来，作为项目团队成员以及项目干系人之间的共识与约定，项目生命周期内的所有项目活动的行动基础，项目团队开展和检查项目工作的依据。 本项目开发计划用于从总体上指导《自由游戏平台》项目顺利进行并最终得到通过评审的项目产品。本项目开发计划面向项目组全体成员。 背景 《自由游戏平台》主要功能是,为广大用户提供一个面对面的游戏平台；基本可包括所有保单系列产品，以及国内外比较流行的博彩游戏！该项目在计划中... 项目背景规划

技术文件资料编写内容

第六部分供应商须知附表 序号容说明与要求 1 采购人名称省地质环境监测总站 2 供应商的资质要求具备三级以上（含三级）物业服务企业资质 3供应商应提交的商务文件 (1) ★报价函； (2) ★法定代表人授权委托书，如法定代表人参加报价， 提供法定代表人复印件； (3) ★营业执照副本复印件； (4) ★按照“供应商的资质要求”规定提交相关证明材料 复印件； (5)用于评审的证明材料： 1)小型、微型企业产品价格需扣除的，须提供： ①《中小企业声明函》、《从业人员声明函》； ②上一年度资产负债表、损益表的复印件。 ③如供应商为监狱企业，须提供省级以上监狱管理局、戒 毒管理局（含生产建设兵团）出具的属于监狱企业的 证明文件复印件。 (6)供应商认为需要提供的其他商务文件； 4供应商应提交的技术文件

(7) ★报价一览表； (8) ★报价明细表 (9)服务规偏离表； (10)供应商自行编写的技术文件： ①提供详细可行的服务方案，包括但不限于保洁绿化、秩序维护、设备运行维护、会议室服务、物业档案管理方 案等； ②确保顺利接管的措施； ③管理制度； ④培训方案； ⑤优惠服务承诺； （11）投标人认为需要提供的其他技术文件。 5 供应商应单独提交的文件 单独密封的报价一览表（2 份），均须加盖供应商公章，否则作无效报价处理；单独密封的报价保证金退付表。 6 是否允许联合体报价不允许。 7 是否允许供应商将项目非主体、 非关键性工作交由他人完成 不允许。 8 是否安排现场踏勘是，联系人：笑泉。 9 中小微型企业有关政策

(1)根据工信部等部委发布的《关于印发中小企业划型标准规定的通知》（工信部联企业[2011]300 号）规定执行； (2) 按照《财政部司法部关于政府采购支持监狱企业发展有关问题的通知》（财库【2014】68 号）文件规定，在政府采购活动中，监狱企业视同小型、微型企业，享受评审中价格扣除的政府采购政策。 (3)价格扣除幅度：价格给予8%的扣除。 10 项目预算人民币陆拾伍万元整（￥650,000 元）。 11 报价保证金额人民币壹万叁仟元整(13,000 元)。 12 履约保证金 (1)合同金额的10%，于签订合同前交纳； (2)服务期满无质量问题后退还。 13 公证费/见证费 中标金额的0.8‰（如金额低于500 元的，按500 元计算，金额高于8000 元的，按8000 元计算），于签订合同前向公证机构/律师事务所交纳。 14 付款途径预算国库集中支付 15 付款方式 其他支付方式合同生效之日起20 个工作日，支付合同 金额的25 %；服务期限自第二季度起， 每季度末验收合格支付合同金额的25% 16 接管时间合同生效之日起7 日

开发文档介绍

开发文档介绍 软件开发文档是软件开发使用和维护过程中的必备资料。它能提高软件开发的效率，保证软件的质量，而且在软件的使用过程中有指导，帮助，解惑的作用，尤其在维护工作中，文档是不可或缺的资料。 软件文档可以分为开发文档和产品文档两大类。 开发文档包括：《功能要求》、《投标方案》、《需求分析》、《技术分析》、《系统分析》、《数据库文档》、《功能函数文档》、《界面文档》、《编译手册》、《QA 文档》、《项目总结》等。产品文档包括：《产品简介》、《产品演示》、《疑问解答》、《功能介绍》、《技术白皮书》、《评测报告》。用户文档《安装手册》、《使用手册》、《维护手册》、《用户报告》、《销售培训》等。 开发文档 1. 《功能要求》-- 来源于客户要求和市场调查，是软件开发中最早期的一个环节。 客户提出一个模糊的功能概念，或者要求解决一个实际问题，或者参照同类软件的一个功能。有软件经验的客户还会提供比较详细的技术规范书，把他们的要求全部列表书写在文档中，必要时加以图表解说。这份文档是需求分析的基础。 2. 《投标方案》-- 根据用户的功能要求，经过与招标方沟通和确认，技术人员开 始书写《投标方案》，方案书一般包括以下几个重要的章节：前言-- 项目背景、公司背景和业务、技术人员结构、公司的成功案例介绍等。需求分析-- 项目要求、软件结构、功能列表、功能描述、注意事项等。技术方案-- 总体要求和指导思想、技术解决方案、软件开发平台、网络结构体系等。项目管理-- 描述公司的软件开发流程、工程实施服务、组织和人员分工、开发进度控制、软件质量保证、项目验收和人员培训、软件资料文档等。技术支持-- 公司的技术支持和服务介绍、服务宗旨和目标、服务级别和响应时间、技术服务区域、技术服务期限、授权用户联系人等。系统报价-- 软、硬件平台报价列表、软件开发费用、系统维护费用等。项目进度-- 整个项目的进度计划，包括签署合同、项目启动、需求分析、系统分析、程序开发、测试维护、系统集成、用户验收、用户培训等步骤的时间规划。 3. 《需求分析》-- 包括产品概述、主要概念、操作流程、功能列表和解说、注意 事项、系统环境等。以《功能要求》为基础，进行详细的功能分析( 包括客户提出的要求和根据开发经验建议的功能) ，列出本产品是什么，有什么特殊的概念，包括哪些功能分类，需要具备什么功能，该功能的操作如何，实现的时候该注意什么细节，客户有什么要求，系统运行环境的要求等。这里的功能描述跟以后的使用手册是一致的。 4. 《技术分析》-- 包括技术选型、技术比较、开发人员、关键技术问题的解决、 技术风险、技术升级方向、技术方案评价，竞争对手技术分析等。以《需求分析》为基础，进行详细的技术分析( 产品的性能和实现方法) ，列出本项目需要使用什么技术方案，为什么，有哪些技术问题要解决，估计开发期间会碰到什么困难，技术方案以后如何升级，对本项目的技术有什么评价等。 5. 《系统分析》-- 包括功能实现、模块组成、功能流程图、函数接口、数据字典、 软件开发需要考虑的各种问题等。以《需求分析》为基础，进行详细的系统分析( 产

软件开发计划模板

文档控制变更记录

目录 1范围 (1) 1.1标识 (1) 1.2系统概述 (1) 1.3文档概述 (1) 1.4与其他计划的关系 (1) 2引用文件 (2) 3术语和定义 (2) 3.1术语 (2) 3.2缩略语 (2) 4策划背景概述 (2) 5项目范围 (3) 5.1项目目标 (3) 5.1.1客户目标 (3) 5.1.2组织目标 (3) 5.1.3研究目标（可裁剪） (3) 5.2工作产品与服务 (4) 5.2.1工作产品 (4) 5.2.2服务 (6) 5.3验收标准 (6) 6组织机构与人员 (6) 7开发及运行环境 (8) 7.1软件开发环境 (8) 7.2软件运行环境 (8) 8重用分析 (8)

9软件开发管理 (9) 9.1软件开发方法及标准 (9) 9.2生命周期模型和项目过程定义 (9) 9.3工作任务拆分与估计 (9) 9.4项目进度和里程碑 (10) 9.5风险管理 (10) 9.6外部依赖 (12) 9.7相关方参与计划 (12) 9.8项目培训计划 (13) 9.9项目监督和问题处理 (13) 9.10数据管理计划 (14) 9.11重大事件处理 (14) 10里程碑及评审计划 (14) 11总体测试计划 (15) 12度量分析计划（可裁减单独成文）................. 错误！未定义书签。13安全保密. (16) 14附录 (17)

图 6-1项目软件研制组织结构 (7) 图 9-1软件技术流程图 (9)

表 3-1缩略语表 (2) 表 5-1交付软件 (4) 表 5-2需交付文档 (4) 表 5-3非交付文档 (4) 表 5-4过程记录 (5) 表 6-1软件项目人员配置 (7) 表 8-1重用分析表 (8) 表 9-1项目风险列表 (11) 表 9-2外部依赖跟踪表 (12) 表 9-3 相关方参与计划 (12) 表 9-4 培训计划 (13) 表 10-1软件正式评审计划 (14) 表 14-1 工作任务拆分结构（WBS） (18)

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

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

软件开发技术文档

病案无纸化管理系统 目录： 一、系统简介 二、组织框架 三、物流与功能流程 、系统简介 二、组织框架 1. 机构

1.1、层次 共分三级：公司级、分店部门级和班组织。如图1-1 1.2、现有机构组成 公司级：总经理室； 部门级：分布在具体地区的连锁店（加盟店、特许店），公司各职能部门（人事行政部，财务部、信息管理部、市场营销采购部、企划管理部等）、配送中心班组级：分店和配送中心的管理班组； 1.3、职能与权限 下面我只对与系统开发有关的机构职能进行阐述（按层次说明）： 公司级： 1.3.1、总经理室 1.3.1.1、制定公司整体发展策略； 131.2、批准销售计划；协调公司内各部门的工作； 131.3、管理监督和指导下属各分店（部门）的工作； 131.4、决定公司高层人事的变动； 1.3.1.5、分析公司的销售、库存、采购、付款等情况；

1.3.1.6、批准各分店和配送中心的盘点、损益报告及价格政策公司部门级： 1.3.2、人事行政部 1.3. 2.1、负责人员的工资考勤、招聘、培训、建档、考核、晋级、定级、奖惩和解聘； 1.3. 2.2、管理全公司的固定资产以及办公用品 1.3.3、财务部 1.3.3.1、处理公司日常财务事宜； 1.3.3.2、根据销售数据和总经理室或市场营销采购部的要求支付货款，并记录货款流水； 1.3.3.3、根据合同（协议）制定出财务付款计划；对进出发票进行管理； 1.3.3.4、根据分店和配送中心提供的销售、进货、配送、退货、退厂、调价、优惠、损益、报残、盘点数据，对公司进、销、存按进价和售价进行核算； 1.3.4、财务部市场营销采购部 1.3.4.1、实施商品的引进、退货、更新、定位和淘汰； 1.342、制定价格政策（调价和优惠）和促销计划（方案）并付诸实施； 1.3.4.3、为总经理室和其他部门提供相关报表和数据； 1.344、制定付款计划报总经理批准后交财务部实施；

软件开发规划项目规范标准

软件项目开发和管理规范 本文阐述软件项目开发和管理的流程规范，作为软件项目开发的高级指引，本规范定义了软件开发的各个阶段以及每个阶段的工作活动和工件，但不对活动和工件的细节作过多规定。在项目开发过程中，每个项目根据自身的需要确定这些活动和工件的细节。 项目阶段 图2-1 项目开发的五个阶段 ?启动阶段 这个阶段的工作目的是决定一个项目是否需要启动。为了达到这个目的，首先要明确项目的总体战略目标，对项目的需要建立认同。即确定到底需要做什么、开发什么产品或提供什么服务，以及需要解决什么样的问题和需要满足客户或市场的什么要求等，同时还要总结项目工作的范围、所需资源、大约开支、各种风险，以及该项目不执行的其他替代选择等。这些代表了对整个项目目标从战略角度和宏观层次所进行的分析，通过项目的意向书总结出来，由此确证客户或项目发起人和赞助者的要求与期望，并帮助他们判定项目是否上马。项目意向总结书的通过及项目被批准上马形成了这个项目的起始点。 ?计划阶段 这个阶段的工作是为整个项目做计划。项目开始后，首先要确定项目的具体范围，明确定出项目到底要做什么，总结、归纳并定出产品的功能。然后进一步制定项目的计划，列出每项具体工作，并建立所有工作任务的重要性及顺序；确定每项工作的执行人和所需资源；根据人员的配置和能力设定各项工作和整个项目的完成时间表。 ?执行阶段

这个阶段的工作是通过执行项目的计划来完成项目的任务。它包括落实一切所需资源，如：人员、设备、费用、技术、信息，由管理者领导全体项目参与者开展各项工作。同时跟踪各项具体工作和整个项目的进度，定期向全体项目人员及项目的发起人报告项目状态。 ?控制阶段 这个阶段的工作是确证项目工作的结果符合项目的计划。它通过对项目结果的衡量和审核，与项目计划所期望的结果进行比较，找出实际结果与计划的差别，并制定处理措施。这个阶段的工作还包括对项目进程中出现的任何更改要求进行审核和批准。同时调解项目进程中出现的各种问题，如：对缺乏的资源的补偿调节；对项目的进度表及各项具体工作的优先级或顺序的修订。 ?结束阶段 这个阶段的工作是确保项目的最终结果或提交物达到计划的要求，并对完成的结果作可接受的确认。还包括在项目完成之后的收尾工作，对整个项目的经历进行总结，修订项目文档，用户培训等。 阶段完成标志 在项目开发过程中，当一个阶段完成后才会开展下一个阶段的工作；另外，“某个阶段完成”通常被定义为项目的一个里程碑，里程碑标识了项目的进度，它是项目开发和控制的重要参考，对整个项目有重要的意义。因此，“确证某个阶段是否已经完成”的工作非常有重要。 ?每一个阶段的结束以它特定任务的完成为象征 只有当某个阶段中被规定的所有工作任务都完成了，这个阶段才算真正结束，整个项目才可以进入到下一个阶段中去。反过来说，要是阶段中某个任务没有全部完成，按照项目的定义，整个阶段就不能算是完成，因此项目就不能进入到下一个阶段去。 ?衡量阶段结束的工作结果必须是实在的交付品 阶段中的任务是否完成是透过任务活动中产生的交付品来体现的，交付品必须是可交付的、非抽象的、实质的并且可以通过用衡量的方法来判断是否真正地完成了的具体事物。如：某一阶段的完成是以建造一个样品或完成某分文件作为象征。任何项目阶段的结束，都应该有这样的实质性东西的完成作为象征。 ?跨阶段的进程以阶段结尾的合格验证和审核来决定 当一个阶段结束时，在进入到下一个阶段之前所需要做的工作应包括对交付品进行合格验证，并检查这一阶段的工作质量和效率，由此判断是否可以进入到下一个阶段。这些检验象征了一个阶段的结尾终点，表示项目的进程离开了上一个阶段而进入了下一个阶段。

技术文档如何写

技术文档如何写 作者：曾盛开（广智公司技术一部） 拥有准确的技术文档不仅对于公司是非常有益处的，而且也能够让客户从中受益。由于产品如何使用在某种程度上是要依赖技术文档来进行说明的，因此技术文档必须十分的准确可靠。使用不准确的和已经过时的技术文档对于公司的发展也会产生一定的阻碍，同样的，它也会对公司的客户们产生消极的影响。一旦客户发现在他们使用产品的时候遇到了问题，却不能通过求助于伴随产品的技术文档的手段进行解决的时候，客户们就会对这种产品产生怀疑乃至于失去信心，那么，公司的信誉和利益自然而然的就会受到损害。这就是不准确的和过时的技术文档给我们带来的危害。 缺乏准确性以及内容晦涩难懂都会让开发新手以及其他的一些技术工作者们对这些技术文档敬而远之，从而不利于他们的学习和掌握。在本篇文章中，我们要讨论的就是如何在你的开发小组中编写出准确而且易于掌握的技术文档。 技巧一：制定出一个技术评价核对表 许多的程序开发设计者以及管理者都缺乏从技术上评价一个文档的经验。这里有一些方法可以提高这些技术文档的准确性： 把注意力集中于技术事实上，这样能够核实这些技术是作为技术文档而被编写出来的。技术评论的工作并不等同于一般的编辑工作。 一定要从技术上核实，在技术文档里编写的程序与步骤的准确性。 一定要从技术上核实，在技术文档中使用的图片捕捉的准确性。 技巧二：一定要在技术文档编写的过程中明确责任 技术文档编写不好的一个原因常常是由于对它不够重视。这是由于在编写技术文档的时候，没有十分的明确各种责任。因此，一定要在技术文档编写的过程中明确责任，这些方法包括： 在技术文档中加入作者以及相关人员的姓名。一些公司可能有规定，禁止出现员工的姓名，但是在技术文档中包含作者以及相关人士姓名的做法能够促进这些内部员工之间的交流。对于外部的文档使用者，比如为商业现货软件编写的用户指南，可以加入作者以及相关人员的姓名，用以明确和承认他们对开发所做的工作和贡献。 把文档的技术评论作为提供给开发设计人员的年度评论的一部分。 在项目计划中指派专人负责技术评论的工作。 技巧三：增加技术文档编写者的准确性 由于技术文档编写者在许多公司内都是非常主观的一个职位，并且编写技术文档也是他们最主要的职责，因此做这些工作的人都必须与他们所编写的技术文档的准确性有着直接的利害关系。 管理人员应该为技术文档编写者设置适当的技术准确级别，并要求他们把准确性保持在这一范围之内。由于一些技术文档编写者对于提升自己对于技术的理解总是不太积极主动，因此，增加他们的责任让他们面对更多的压力对项目里的每一个人来说都是有好处的。如果一个技术文档编写者无法达到更高的标准，那么你就需要重新审视一下你的技术文档编写者是否能够满足你们的团队的战略要求，是否能够满足客户们的需要呢？ 为了帮助技术文档编写者，你需要让他们对于具体的技术有着更深层次的认识，因此，作为管理者，你应该： 让技术文档编写者多参加有关产品设计与开发的小组会议。 让技术文档编写者参与到技术要求、功能规范以及设计方案的开发工作中去。