软件过程文档编写规范【全】
DOC.NO. Tech-Spec-Docu
普通
XXX部 文档编写规范
Version. 1.0
XXXX
2002-9-21
XXXXX公司
Tel: (0592)XXXXXXX
Fax: (0592) XXXXXXX
Email: X XXX@https://www.360docs.net/doc/db6627013.html,
https://www.360docs.net/doc/db6627013.html,
COMPANY CONFIDENTIAL AND PROPRIETRAY ?2001-2005 XXXXX All rights Reserved
文档编写规范
文档信息
分发名单
*行动类别: 批准, 复审, 通知, 存档, 所需行动, 参加会议,其它(请指明) 版本记录
目录
1 规范说明 (5)
1.1 目的 (5)
1.2 适用范围 (5)
1.3 名词解释 (5)
1.4 正文内容 (5)
1.5 解释权限 (5)
1.6 施行日期 (5)
2 文档统一格式定义 (6)
2.1 文档页面设置 (6)
2.2 封面格式 (6)
2.3 文档版本说明格式 (7)
2.4 页眉与页尾格式 (7)
2.5 目录格式 (7)
2.6 正文格式 (7)
3 文档编写规范 (8)
3.1 需求说明书 (8)
3.1.1 引言 (8)
3.1.2 业务流程整体说明（使用业务语言） (8)
3.1.3 特殊说明 (8)
3.1.4 原始资料 (8)
3.2 需求分析报告 (9)
3.2.1 引言 (9)
3.2.2 任务概述 (9)
3.2.3 数据描述 (9)
3.2.4 功能需求 (10)
3.2.5 性能需求 (10)
3.2.6 运行环境描述 (10)
3.2.7 其他需求 (11)
3.3 概要设计书 (11)
3.3.1 引言 (11)
3.3.2 总体设计 (11)
3.3.3 接口设计 (11)
3.3.4 数据结构设计 (12)
3.3.5 出错处理设计 (12)
3.3.6 安全保密设计 (12)
3.4 详细设计书 (12)
3.4.1 引言 (12)
3.4.2 总体设计 (13)
3.4.3 程序描述 (13)
3.5 测试计划 (13)
3.5.1 引言 (13)
3.5.2 计划 (14)
3.5.3 测试项目说明 (14)
3.5.4 评价 (14)
3.6 测试报告 (14)
3.6.1 引言 (14)
3.6.2 测试计划执行情况 (15)
3.6.3 评价 (15)
3.7 模块开发文档 (15)
3.7.1 功能说明 (15)
3.7.2 设计说明 (15)
3.7.3 源代码清单 (16)
3.7.4 测试说明 (16)
3.7.5 复审结论 (16)
3.8 用户手册 (16)
3.8.1 引言 (16)
3.8.2 系统功能介绍 (16)
3.8.3 运行环境说明 (16)
3.8.4 运行前的准备 (17)
3.8.5 输入输出说明和操作说明 (17)
3.8.6 安全与保密 (17)
3.8.7 常见问题的处理 (17)
3.8.8 附录：安装与初始化 (17)
3.9 试运行计划 (18)
3.9.1 引言 (18)
3.9.2 开发背景介绍 (18)
3.9.3 运行环境介绍 (18)
3.9.4 软件流程及模块功能说明 (18)
3.9.5 试运行所需资料 (18)
3.9.6 特殊业务的处理方法说明 (19)
3.9.7 试运行所需的业务基础数据 (19)
3.9.8 试运行进度安排 (19)
3.10 验收报告 (19)
3.10.1 引言 (19)
3.10.2 验收内容 (19)
3.10.3 软件验收结论 (19)
1规范说明
1.1 目的
为了本公司信息系统建设过程逐步规范化，实现信息系统的软件工程化实施，结合本公司的具体情况特编制《文档编制规范》。以便将来作为本公司信息系统建设软件工程化基础的一部分。
1.2 适用范围
本规范适用于XXXX。
1.3 名词解释
无
1.4 正文内容
在《文档编写规范》中定义了在项目开发和产品开发过程中必须生成的主要文档以及文档的格式与内容，这些文档包括：需求说明书、需求分析报告、概要设计书、详细设计书、测试计划、测试报告、用户手册、模块开发文档、试运行计划、验收报告。
1.5 解释权限
本规范由技术管理部负责解释。
1.6 施行日期
本规范自颁布之日起施行。
2文档统一格式定义2.1 文档页面设置
2.2 封面格式
见封面
2.3 文档版本说明格式
2.4 页眉与页脚格式
2.5 目录格式
各索引条目必须是正文的超链接：鼠标单击索引条目后进入正文。
2.6 正文格式
3文档编写规范
3.1 需求说明书
3.1.1引言
?编写目的（阐明编写需求说明书的目的）
?项目背景（应包括：a.项目的委托单位、开发单位和主管部门；b.该软件系统与其他系统的关系。）
?名词解释（列出文档中所用到的专门术语的定义和缩写词的原文。）
?参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：a.立项报告；b.项目开发计划；c.文档所引用的资料、标准和规范。）
3.1.2业务流程整体说明（使用业务语言）
业务人员首先应对业务有一个总体流程图，同时辅以文字说明。如果总的流程图的各个组成部分还可以细分的话，应继续用子流程图的形式对它的各组成部分进行说明并辅以文字说明，直到流程图的各个组成部分的业务步骤不可再分为止。例如代理录入订单，在详细描述中应包括以下内容：订单的详细信息；代理编号（长度要求，需要代理手工选择）；订单号（长度要求、需要代理手工输入）……………。
3.1.3特殊说明
需要特殊说明的一些问题，例如本系统与现有其他软件系统的关系等。
3.1.4原始资料
?资料收集：应收集所有与业务需求相关的原始资料，为后续工作（如：需求分析等）
做准备。
?原有业务流程概述：对原有业务流程进行说明（采取流程图方式）
?原始单据、原始报表等：以列表的方式列出原始资料的名称，而且要与原有业务流程概述的内容相对照，并将实际的原始资料附在业务分析书的后面。
3.2 需求分析报告
3.2.1引言
?编写目的（阐明编写需求分析报告的目的）
?项目背景（应包括：a.项目的委托单位、开发单位和主管部门；b.该软件系统与其他系统的关系。）
?名词解释（列出文档中所用到的专门术语的定义和缩写词的原文。）
?参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：a.立项报告；b.项目开发计划；c.文档所引用的资料、标准和规范。）
3.2.2任务概述
?目标
叙述该项软件开发的意图、应用目标、作用范围以及该软件的背景资料。解释被开
发软件与其他有关软件之间的关系。如果本软件是一个独立的软件，而且全部内容
自含，则说明这一点。如果定义的产品是一个更大系统的一个组成部分，则应说明
本产品与该系统中其他各组成部分之间的关系。
?假定与约束
列出本软件开发工作的假定与约束，例如经费限制、开发期限等等。
3.2.3数据描述
数据分为静态数据和动态数据。所谓静态数据，指在运行过程中主要作为参考的数据，它们在很长一段时间内不会变化，一般也不会随着运行而改变，所谓动态数据，包括所有在运行中要发生变化的数据，以及在运行中要输入、输出的数据。
?静态数据（系统运行前已有的数据）
列出所有作为控制或参考用的静态数据，并给出名称。
?动态数据（系统运行过程中需要的输入数据以及系统运行过程中产生的输出数据）列出所有动态数据，并给出名称。
?流程图
画出系统的整体流程图。
?功能划分
对于流程图中的各个功能用树状结构自顶向下进行细化。并对最底层的功能进行编
码，给出功能标识符。
?功能描述
?数据与功能的对应关系
用一张矩阵图说明功能描述中的各个功能与数据描述中的静态数据、动态数据之间
的对应关系，例如：
3.2.5性能需求
?时间要求
例如响应时间、更新处理时间、数据转换和传送时间等等。
?适应性（在操作方式、运行环境、与其他软件的接口等发生变化时，所具有的适应能力。）
3.2.6运行环境描述
?硬件设备
?支持软件（操作系统、数据库、其他软件系统如：Lotus Notes等）
?接口（硬件接口、软件接口）
?控制（说明控制该软件的运行的方法）
?用户界面（反映业务流程的用户界面）
?如可用性、安全保密、可维护性、可跨平台性等。（分高、中、低定性详细描述）3.3 概要设计书
3.3.1引言
?编写目的（阐明编写概要设计书的目的，指明读者对象。）
?项目背景（应包括：a.项目的委托单位、开发单位和主管部门；b.该软件系统与其他系统的关系。）
?定义（列出本文档中所用到的专门术语的定义和缩写词的原意。）
?参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：立项报告；项目开发计划；需求分析报告；文档所用的资料、采用的标准
或规范。）
3.3.2总体设计
?需求概述
?运行环境
简要的说明对本系统的运行环境（包括硬件环境和支持环境）的规定?处理流程
针对《需求分析报告》中功能需求的功能描述部分，用图的形式表示出完成该功能
的模块的处理流程。并注明各个模块之间的接口参数。
?总体结构
针对《需求分析报告》中功能需求的功能描述部分，用树状图的形式，自顶向下的
表示出完成该功能的所有模块的结构图。
?功能分配（表明各项功能与程序结构的关系。）
用一张矩阵图说明各项功能需求的实现与各模块的分配关系。
3.3.3接口设计
?用户接口
说明向用户提供的命令和它们的语法结构，以及软件的回答信息
?外部接口
说明本系统与外界的所有接口，包括软件与硬件之间的接口，本软件与其他软件之
间的接口关系。
?内部接口
针对在总体设计部分的总体结构中列出的模块树状结构图，对树状图中位于同一层
的各个模块之间的接口进行详细说明。
3.3.4数据结构设计
?逻辑结构设计（数据字典）
?物理结构设计
数据字典的存储要求、访问方法、存取的物理关系（包括索引、设备等等）?数据结构与程序的关系
用一张矩阵图说明各个数据库表与各模块的对应关系。
3.3.5出错处理设计
?出错输出信息
用表的形式说明可能出现的出错或故障情况出现时，系统输出信息的形式，含义以
及处理方法。
?出错处理对策
说明故障出现后可能采用的补救措施，包括：
后备技术：当原始数据丢失时起用数据副本的技术
性能降级：当系统崩溃时，暂时采用人工处理的办法
恢复及再启动：是软件从故障点恢复执行或使软件从头开始运行的方法
3.3.6安全保密设计
指从系统安全保密角度考虑，在程序设计和数据库设计中作出的一些安排。例如为了保证传输数据的完整性与保密性，需要在传递数据前对数据进行加密。
系统维护设计
说明为了系统维护的方便而在程序设计中作出的安排，包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。
3.4 详细设计书
3.4.1引言
?编写目的（阐明编写详细设计书的目的，指明读者对象。）
?项目背景（应包括：a.项目的委托单位、开发单位和主管部门；b.该软件系统与其他系统的关系。）
?定义（列出文档中所用到的专门术语的定义和缩写词的原意。）
?参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：项目的计划任务书、合同或批文；立项报告.；项目开发计划；需求分析
报告；概要设计书；测试计划；文档中所引用的其他资料、软件开发标准或规范。）3.4.2总体设计
?需求概述
?软件结构（如给出软件系统的结构图。）
对《概要设计书》中的总体结构部分的各个模块，用列表的方式给出该模块包含的
程序的名称、标识符、功能列表。
3.4.3程序描述
（逐个程序给出以下的说明：）
?功能
说明该程序应具有的功能。
?性能
说明对该程序的性能要求，包括精度、灵活性、时间特性等要求。
?输入项目
给出每一个输入项目的特性，包括名称、标识符、数据的类型和格式、数据值的有
效范围、输入的方式、输入媒体等等。
?输出项目
给出每一个输出项目的特性，包括名称、标识符、数据的类型和格式、数据值的有
效范围、输出的形式、输出媒体等等。
?算法
本程序所选用的算法，具体的计算公式和计算步骤。
?流程逻辑
用流程图的形式辅以必要的说明来表示本程序的逻辑流程。
?接口
说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序，说明参数
赋值和调用方式，说明与本程序直接关联的数据库。
?限制条件
?测试要点（给出测试模块的主要测试要求。）
?尚未解决的问题
3.5 测试计划
3.5.1引言
?编写目的（阐明编写测试计划的目的并指明读者对象。）
?项目背景
?本测试计划所从属的软件系统的名称；
?项目的委托单位、开发单位和主管部门；
?该软件系统与其他系统的关系。
?定义（列出测试计划中所用到的专门术语的定义和缩写词的原意。）
?参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：a.项目的计划书、合同或批文；b.项目开发计划；c.需求分析报告；d.概要
设计书；e.详细设计书；f.用户手册；g.本测试计划中引用的其他资料、采用的软件
开发标准或规范。）
3.5.2计划
?测试方案（说明确定测试方法和选取测试用例的原则如：用户界面测试、功能流程测试、性能测试。）
?测试项目（列出组装测试和确认测试中每一项测试的内容、名称、目的和进度。）?测试准备
?测试机构及人员（测试机构名称、负责人和职责。）
3.5.3测试项目说明
（按顺序逐个对测试项目做出说明：）
?测试项目名称及测试内容
?测试用例
1.输入（输入的数据和输入命令。）
2.输出（预期的输出数据。）
3.步骤及操作
?进度
?条件（给出项测试对资源的特殊要求，如设备、软件、人员等。）
?测试资料（说明项测试所需的资料。）
3.5.4评价
?范围（说明所完成的各项测试说明问题范围及其局限性。）
?准则（说明评价测试结果的准则。）
3.6 测试报告
3.6.1引言
?编写目的（阐明编写测试报告的目的并指明读者对象。）
?项目背景
?本测试计划所从属的软件系统的名称；
?项目的委托单位、开发单位和主管部门；
?该软件系统与其他系统的关系。
?定义（列出测试报告中用到的专门术语的定义和缩写词的原意。）
?参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：a.项目的计划任务书、合同或批文；b.项目开发计划；c.需求分析报告；
d.概要设计书；
e.详细设计书；
f.用户手册；
g.测试计划；
h.所引用的其他资料、采
用的软件工程标准或软件工程规范。）
3.6.2测试计划执行情况
?测试项目（用表格的形式列出每一测试项目的名称、内容和目的。）
?测试机构和人员（给出测试机构名称、负责人和参与测试人员名单。）
?测试结果（按顺序给出每一测试项目的：a.实测结果数据；c.该项测试表明的事实；
d.该项测试发现的问题。）
软件需求测试结论
?顺序给出每一项需求测试的结论。包括：a.证实的软件能力；b.局限性（哪项需求未得到充分测试的情况及原因。）
3.6.3评价
?软件能力（经过测试所表明的软件能力。）
?建议（提出为弥补上述缺陷的建议。）
?缺陷和限制（说明测试所揭露的软件缺陷和不足，以及可能给软件运行带来的影响。）
?测试结论（说明能否通过。）
3.7 模块开发文档
3.7.1功能说明
说明本模块或本组模块的功能，主要是输入、要求的处理、输出，并附上《需求分析报告》中对这些功能的说明部分。
3.7.2设计说明
说明本模块的设计考虑，包括：
1.在《概要设计书》中对本模块（或本组模块）设计考虑的叙述，包括本模块在软件
系统中所处的层次，它同其他模块的接口。
2.在《详细设计书》中对本模块（或本组模块）的设计考虑，包括本模块的算法、处
理流程、出错信息等等
3.在编写源代码时实际使用的设计考虑
3.7.3源代码清单
给出已通过全部测试的源代码清单。
3.7.4测试说明
说明该模块自测试的目的、输入、预期的输出和实际的输出。
3.7.5复审结论
把实际测试的结果，同《需求分析报告》、《概要设计书》、《详细设计书》中规定的要求进行比较并给出结论。
3.8 用户手册
3.8.1引言
?编写目的（阐明编写用户手册的目的并指明读者对象。）
?项目背景
?本用户手册所从属的软件系统的名称；
?项目的委托单位、开发单位和主管部门；
?该软件系统与其他系统的关系。
?定义（列出用到的专门术语的定义和缩写词的原意。）
?参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：a.项目的计划任务书、合同或批文；b.项目开发计划；c.需求分析报告；
d.概要设计书；
e.详细设计书；
f.测试计划；
g.所引用的其他资料、采用的软件工程
标准或软件工程规范。）
3.8.2系统功能介绍
按照软件使用者的一般工作分工说明软件所具有的功能、这些功能帮助使用者解决实际工作中的哪些问题、使用软件后的优点。
3.8.3运行环境说明
简单说明运行本软件所要求的：
?硬件设备环境，例如使用什么型号的计算机、配备多少内存及硬盘等；
?系统软件的环境，例如WINDOWS、SQL*NET等；
?应用软件环境，例如运行本软件时需要在系统中有哪些其他子系统的支持等。
必要时可以说明软件运行的基本环境和最佳环境。
3.8.4运行前的准备
说明这个软件在运行前用户应该作的准备工作，如：代码的编制、数据的准备、工作流程的调整等等。在这里应该列出所需要做的准备工作清单，以告诉用户在使用前应做好的准备工作。有些系统初始化的工作，特别是需要系统维护人员操作的安装和初始化工作操作方法可在后面附录的安装与初始化中描述，在这里不必详细说明。
3.8.5输入输出说明和操作说明
这一部分是用户手册的核心，这部分内容应该按照工作的流程顺序来编写。
对于每个相对独立运行的子系统或程序模块，应说明软件的进入和退出方法。（在WINDOWS环境下的软件只需说明快捷方式启动软件的方法即可，通常情况下不必再说明用命令启动软件的方法。）
在编写操作说明时为了用户使用的方便，应该针对每一个工作流程编写相应的软件操作步骤和方法，其内容应该包括：
?功能简介。
?工作流程中相应软件模块的进入与退出方法。
?以醒目的方式列出常规工作时操作步骤，详细说明每个步骤中的屏幕和使用方法?这一部分应该尽量让软件的使用操作人员对整个操作过程有一个明确的概念，在文件编排上应该把使用者的注意力集中在使用软件解决他工作中的问题上。
?对向计算机输入的数据和计算机输出的内容给予适当的说明。
在语言上应该使用易于用户理解的词汇而尽量不要用计算机专业术语。
3.8.6安全与保密
说明软件对保密管理的要求及违反保密规定后可能造成的后果。在一些子系统中，保密字乱用后，可能造成个人工作量统计错误等等。
3.8.7常见问题的处理
根据需要说明在使用中可能遇到的问题及其解决方法。这些问题往往是由于在使用过程中的错误操作造成的。对于一些能够预见的，经常可能遇到的问题应该在用户手册中提供解决的方法，这样能够减少很多为用户提供使用咨询的工作量。
3.8.8附录：安装与初始化
?安装
列出软件安装的步骤，说明安装过程中的每一步操作方法。这一部分的内容应该让
初次接触这个系统的使用者依照手册中所列的步骤和操作方法顺利地将软件安装
上。
?初始化
列出软件正式运行前所需要进行初始化工作的清单和初始化操作的步骤。对于初始
化中的每个步骤应给予适当的说明，使进行初始化工作的人能够充分理解初始化中
每一步骤的实际作用，以便于合理地配置应用系统，充分发挥系统的作用
3.9 试运行计划
3.9.1引言
?编写目的（阐明试运行计划的目的并指明读者对象。）
?项目背景
?软件系统的名称；
?项目的委托单位、开发单位和主管部门；
?该软件系统与其他系统的关系。
?定义（列出文档中用到的专门术语的定义和缩写词的原意。）
?参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：a.项目的计划书、合同或批文；b.项目开发计划；c.需求分析报告；d.概要
设计书；e.详细设计书；f.用户手册；g.测试计划；h.所引用的其他资料、采用的软
件工程标准或软件工程规范。）
3.9.2开发背景介绍
包括业务需求提出的起因、项目负责人、开发人员（开发商）、测试负责人、业务系统涉及部门
3.9.3运行环境介绍
硬件设备、网络环境、软件平台等等
3.9.4软件流程及模块功能说明
提供一份图表或流程图，并逐项说明软件系统各个模块的功能、输入和输出的业务数据的提纲。
3.9.5试运行所需资料
包括用户使用手册、规范的业务操作流程、业务数据、问题记录表等。
3.9.6特殊业务的处理方法说明
3.9.7试运行所需的业务基础数据
3.9.8试运行进度安排
3.10 验收报告
3.10.1引言
?编写目的（阐明编写验收报告的目的并指明读者对象。）
?项目背景
?软件系统的名称；
?项目的委托单位、开发单位和主管部门；
?该软件系统与其他系统的关系。
?定义（列出验收报告中用到的专门术语的定义和缩写词的原意。）
?参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：a.项目的计划书、合同或批文；b.项目开发计划；c.需求分析报告；d.概要
设计书；e.详细设计书；f.用户手册；g.测试计划；h. 所引用的其他资料、采用的
软件工程标准或软件工程规范。）
3.10.2验收内容
验收的基本内容应基于项目开发合同。
?文档（列出每一阶段提交的文档的名称、内容和评价。）
?程序（对于每一子功能的功能测试情况，界面与操作评价，此部分应基于《需求分析报告》和《概要设计书》）
3.10.3软件验收结论
?是否通过验收
?评价
程序流程图编写规范_(终极整理版)
程序流程图规范 1.引言 国际通用的流程图形态和程序： 开始(六角菱型)、过程(四方型)、决策(菱型)、终止(椭圆型)。在作管理业务流程图时，国际通用的形态：方框是流程的描述；菱形是检查、审批、审核（一般要有回路的）；椭圆一般用作一个流程的终结；小圆是表示按顺序数据的流程；竖文件框式的一般是表示原定的程序；两边文件框式的一般是表示留下来的资料数据的存储。 2.符号用法 程序流程图用于描述程序内部各种问题的解决方法、思路或算法。 图1-1 标准程序流程图符号 1)数据：平行四边形表示数据，其中可注明数据名、来源、用途或其 它的文字说明。此符号并不限定数据的媒体。 2)处理：矩形表示各种处理功能。例如，执行一个或一组特定的操作，
从而使信息的值，信息形式或所在位置发生变化，或是确定对某一流向的选择。矩形内可注明处理名或其简要功能。 3)特定处理：带有双纵边线的矩形表示已命名的特定处理。该处理为 在另外地方已得到详细说明的一个操作或一组操作，便如子例行程序，模块。矩形内可注明特定处理名或其简要功能。 4)准备：六边形符号表示准备。它表示修改一条指令或一组指令以影 响随后的活动。例如，设置开关，修改变址寄存器，初始化例行程序。 5)判断：菱形表示判断或开关。菱形内可注明判断的条件。它只有一 个入口，但可以有若干个可供选择的出口，在对符号内定义各条件求值后，有一个且仅有一个出口被激活，求值结果可在表示出口路径的流线附近写出。 6)循环界限：循环界限为去上角矩形或去下角矩形，分别表示循环的 开始和循环的结束。一对符号内应注明同一循环标识符。可根据检验终止循环条件在循环的开始还是在循环的末尾，将其条件分别在上界限符内注明(如：当A>B)或在下界限符内注明(如：直到C 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. 控制精度或生产能力的提高。 附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 ）详细设计说明 1.1需求规格说明书 需求规格相当于软件开发的图纸，一般说，软件需求规格说明书的格式可以根 据项目的具体情况采用不同的格式，没有统一的标准。下面是一个可以参照的 软件需求规格说明书的模板。 1．导言 1.1目的 [说明编写这份项目需求规格的目的，指出预期的读者] 1.2背景 说明： a）待开发的产品名称； b）本项目的任务提出者、开发者、用户及实现该产品的单位； c）该系统同其他系统的相互来往关系。 1.3缩写说明 [缩写] [缩写说明] 列出本文件中用到的外文首字母组词的原词组。 1.4术语定义 [术语] [术语定义] 列出本文件中用到的专门术语的定义。 1.5参考资料 [编号]《参考资料》[版本号] 列出相关的参考资料。 1.6版本更新信息 具体版本更新记录如表所列。 表版本更新记录 2．任务概述 2.1 系统定义 本节描述内容包括： ●项目来源及背景； ●项目要达到的目标，如市场目标、技术目标等； ●系统整体结构，如系统框架、系统提供的主要功能，涉及的接口等； ●各组成部分结构，如果所定义的产品是一个更大的系统的一个组成部分， 则应说明本产品与该系统中其他各组成部分之间的关系，为此可使用一张 方框图来说明该系统的组成和本产品同其他各部分的联系和接口。 2.2 应用环境 本节应根据用户的要求对系统的运行环境进行定义，描述内容包括： ●设备环境； ●系统运行硬件环境； ●系统运行软件环境； ●系统运行网络环境； ●用户操作模式； ●当前应用环境。 2.3 假定和约束 列出进行本产品开发工作的假定和约束，例如经费限制、开发期限等。列出本产品的最终用户的特点，充分说明操作人员、维护人员的教育水平和技术专长以及本产品的预期使用频度等重要约束。 3．需求规定 1.1对功能的规定 本节依据合同中定义的系统组成部分分别描述其功能，描述应包括： ●功能编号； ●所属产品编号； ●优先级； ●功能定义； ●功能描述。 1.2对性能的规定 本节描述用户对系统的性能需求，可能的系统性能需求有： ●系统响应时间需求； ●系统开放性需求； ●系统可靠性需求； ●系统可移植性和可扩展性需求； ●系统安全性需求； ●现有资源利用性需求。 1.2.1精度 说明对该产品的输入、输出数据精度的要求，可能包括传输过程中的精度。 1.2.2时间特性要求 说明对于该产品的时间特性要求，如对： a）响应时间； b）更新处理时间； c）数据的转换和传送时间； d）计算时间等的要求。 1.2.3灵活性 说明对该产品的灵活性的要求，即当需求发生某些变化时，该产品对这些变化的适应能力，如： a）操作方式上的变化； b）运行环境的变化； c）同其他系统的接口的变化； d）精度和有效时限的变化； e）计划的变化或改进。 对于为了提供这些灵活性而进行的专门设计的部分应该加以标明。 1.3输入输出的要求 解释各输入输出的数据类型，并逐项说明其媒体、格式、数值范围、精度等。 对软件的数据输出及必须标明的控制输出量进行解释并举例，包括对硬拷贝报 附录五国家标准《计算机软件产品开发文件编制指南》国家标准《计算机软件产品开发文件编制指南》（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、数据库设计说明书 软件开发技术文档编写规范 在项目开发过程中，应该按要求编写好十三种文档，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。 ◇可行性分析报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。 ◇项目开发计划：为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。 ◇软件需求说明书（软件规格说明书）：对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。 ◇概要设计说明书：该说明书是概要实际阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计提供基础。 ◇详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。 ◇用户操作手册：本手册详细描述软件的功能、性能和用户界面，使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。 ◇测试计划：为做好集成测试和验收测试，需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。 ◇测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。 ◇开发进度月报：该月报系软件人员按月向管理部门提交的项目进展情况报告，报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。 ◇项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对开发工作做出评价，总结出经验和教训。 ◇软件维护手册：主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明，便于软件的维护。 ◇软件问题报告：指出软件问题的登记情况，如日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。 ◇软件修改报告：软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。 1可行性分析报告 1 引言 1.1 编写目的：阐明编写可行性研究报告的目的，提出读者对象。 北京易游无限科技公司 https://www.360docs.net/doc/db6627013.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 引言 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.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 运行环境 描述了软件的运行环境，包括硬件平台、操作系统和版本，还有其它的软件组件或与其共存的应用程序。 编者说明： 软件过程管理中的一个很重要的工作就是制定项目、组织的过程规范，它是软件开发组织行动的准则与指南。该文档就是一个实际的过程规范的实例，通过该实例，相信对大家根据自身情况制定符合要求的项目过程规范、组织过程规范有很好的借鉴作用。 1.总则 最大限度提高Q&P（质量与生产率），提高Q&P的可预见性，是每一个软件开发机构的最大目标。而Q&P依赖于三个因素：过程、人和技术，因此要实现Q&P的提高，除了加强技术能力，引进、培育更多优质技术人才之外，规范、改进机构的过程是一个十分重要的手段。我们希望通过在制定软件过程规范标准，并在软件开发实践中不断地完善、修订，提高Q&P和Q&P的可预见性。 本规范采用CMM（软件过程成熟度模型）的指导，吸收RUP、XP、MSF、PSP、TSP等过程规范指南的思想、方法及实践，充分结合xxx 技术开发部的实际情况，引入先进的技术、方法、工具，为公司的软件开发工作提供一部详细、可操作的过程指南。在本规范的第一版本中，主要包括管理过程和开发过程两个部分，管理过程中包括项目管理过程、需求变更管理过程、配置管理过程。对于软件开发项目中的其它的一些过程将在实践中逐步补充、完善。 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．服务（阐明开发单位可向用户提供的服务. 如人员培训安装保修维护和其他运行支持。） 计算机软件测试文件编制规范 1 引言 1.1 目的和作用 本规范规定一组软件测试文件。测试是软件生存周期中一个独立的、关键的阶段，也是保证软件质量的重要手段。为了提高检测出错误的几率，使测试能有计划地、有条不紊地进行地进行，就必须要编制测试文件。而标准化的测试文件就如同一种通用的参照体系，可达到便于交流的目的。文件中所规定的内容可以作为对测试过程完备性的对照检查表，故采用这些文件将会提高测试过程的每个阶段的能见度，极大地提高测试工作的可管理性。 1.2 适用对象及范围 本规范是为软件管理人员、软件开发人员和软件维护人员、软件质量保证人员、审计人员、客户及用户制定的。 本规范用于描述一组测试文件，这些测试文件描述测试行为。本规范定义每一种基本文件的目的、格式和内容。所描述的文件着重于动态测试过程，但有些文件仍适用其它种类的测试活动。 本规范可应用于数字计算机上运行的软件。它的应用范围不受软件大小、复杂度或重要性的限制，本规范既适用于初始开发的软件测试文件编制，也适用于其后的软件产品更新版本的测试文件编制。 本规范并不要求采用特定的测试方法学、技术及设备或工具。对文件控制、配置管理或质量保证既不指明也不强制特定的方法学。根据所用的方法学，可能需要增加别的文件（如“质量保证计划”）。 本规范既适用于纸张上的文件，也适用于其它媒体上的文件。如果电子文件编制系统不具有安全的批准注册机制，则批准签字的文件必须使用纸张。 2 引用标准 GB/T 11457 软件工程术语 GB 8566 计算机软件开发规范 GB 8567 计算机软件产品开发文件编制指南 3 定义 本章定义本规范中使用的关键术语。 3.1 设计层design level 软件项的设计分解（如系统、子系统、程序或模块）。 3.2 通过准则pass criteria 判断一个软件项或软件特性的测试是否通过的判别依据。 3.3 软件特性software feature 软件项的显著特性。（如功能、性能或可移植性等）。 3.4 软件项software item 源代码、目标代码、作业控制代码、控制数据或这些项的集合。 3.5 测试项test item 作为测试对象的软件项。 4 概述 产品/项目系统名称 配置管理计划 北京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、参考文献 2.1GB8566-88 计算机软件开发规范 2.2ISO/IEC 12207:1995 信息技术——软件生存周期过程 2.3GXB 02-001 软件开发规范：第一部分软件生存周期 2.4GXB 01-001 软件工程术语 2.5GXB 02-007 软件测试规范 3、术语 本标准的术语的定义与GXB 01-001软件工程术语中的定义相一致。 4、需求分析的任务和过程 4.1需求分析任务 确定被开发软件的运行环境、功能、性能和数据需求，建立确认测试准则，编写用户手册，为概要设计提供需求说明书。 4.2需求分析过程 需求分析过程由下列步骤组成： 1）确定需求分析方法和工具； 2）人员培训； 3）确定需求分析输入； 4）需求分析； 5）制定确定测试计划； 6）修改开发计划； 7）编制文档； 8）需求分析审查； 9）需求分析文档存档。 5、总体要求 5.1用户参与 软件需求分析应该有客户指定的人员参加。 5.2用户确认 需求说明必须明确，经过客户同意，并用合同的方式予以确认。 5.3面向用户描述需求 应以用户能够理解的形式和术语描述需求，以利于与用户沟通。 6、需求分析流程 6.1确定需求分析方法和工具 选定合适的需求分析方法，在一个软件项目内所用的分析方法应该保持一致性。候选分析方法： 1）结构分析方法，包括面向数据流的分析方法和面向数据结构的分析方法。 2）面向对象的分析方法。 在需求分析方法选定后，应确定支持该方法的工具。在一个软件项目内，需求建模语言和工具应该保持一致性和规范化。 6.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．技术可行性 本软件拟决定最终在分布式系统上来运行。硬件方面，由于广东传讯网络信息有限公司是国外多 一、前期方案评估 1、主控芯片选型 模块化控制要求，整理系统需要的资源。如系统时钟、普通IO拟需要的数目、中断源的个数、AD采样通道的个数、PWM输出的通道数等。在封装等外形尺寸等符合硬件标准的情况下，从上述方面去考虑主控芯片的型号，优先考虑行业通用或是编程人员熟悉的芯片类型。 对于无参考的新品项目，在做方案时必须对主控芯片的资源做预留，以备功能扩展或是方案更改需要。如至少留出2个以上的普通IO口，1个以上的AD转换口，1个以上的中断资源。 2、主控芯片性能粗测试 初期选型通过的主控芯片，DIY一张DEMO实验板，编写测试程序测试所选芯片是否符合工程需要。主要测试单片机的如下性能： 1）系统时钟的稳定性 2）指令周期 3）端口输入输出延迟 4）极限工作温度区间 5）频漂 6）其它专用功能 经测试后给出测试结论：Y/N。 3、软件方案的制定 3.1 系统资源分配 系统时钟的选择（兼顾系统的运行速度以及实际需求），并非越高越好，如果控制系统要求有精确的定时，优先保证时间精度。如，精确的定时器触发、PWM精确的载波周期等。 依据控制对象的具体情况，把控制需求模块化。对不同的功能模块，采用最适合的单片机资源去实现。对每个模块，详细分析模块的功能以及实现方式，对于核心功能，还需给出软件流程图。如要实现AD采样功能，需给出AD的参考电压、转换通道、转换精度等，并且给出采样值的滤波方法。 3.2 系统结构框架设计 设计系统的工作流程，把各功能模块按照一定的逻辑结构组合成完整的系统，其中包括系统框架图，软件流程图，中断管理等。 对于中断，必须慎重考虑程序被打断后的恢复问题，如程序在运行到AD采样时被某中断打断，中断函数中依然有AD采样，那么在中端函数执行完后，程序在断点继续执行时AD采样寄存器的值已不再是中断执行前的值。 3.3 任务进度安排 指定软件编写责任人以及进度表。相应文档规整，责任人签字确认后存档。 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 管理依据 在软件开过过程中，管理者必须了解开发进度、存在的问题和预期目标。每一阶段计划安排的定期报告提供了项目的可见性。定期报告还提醒各级管理者注意该部门对项目承担的 神州数码（中国）有限公司 秘级：内部保密文件仅限内部使用 概要设计说明书模板 （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) 软件文档管理指南 范围 本标准为那些对软件或基于软件的产品的开发负有职责的管理者提供软件文档的管理指南。本标准的目的在于协助管理者在他们的机构中产生有效的文档。 本标准涉及策略、标准、规程、资源和计划，管理者必须关注这些内容，以便有效地管理软件文档。 本标准期望应用于各种类型的软件，从简单的程序到复杂的软件系统。并期望覆盖各种类型的软件文档，作用于软件生存期的各个阶段。 不论项目的大小，软件文档管理的原则是一致的。对于小项目，可以不采用本标准中规定的有关细节。管理者可剪裁这些内容以满足他们的特殊需要。 本标准是针对文档编制管理而提出的，不涉及软件文档的内容和编排。 引用标准 下列标准所包含的条文，通过在本标准中引用而构成为本标准的条文。本标准出版时，所示版本均为有效，所有标准都会被修订，使用本标准的各方应探讨使用下列标准最新版本的可能性。 计算机软件开发规范 计算机软件产品开发文件编制指南 软件工程术语 定义 本标准采用下列定义，其他定义见。 文档 一种数据媒体和其上所记录的数据。它具有永久性并可以由人或机器阅读。通常仅用于描述人工可读的内容。例如，技术文件、设计文件、版本说明文件。 文档（集）；文档编制 一个或多个相关文档的集合。 文档计划 一个描述文档编制工作方法的管理用文档。该计划主要描述要编制什么类型的文档，这些文档的内容是什么，何时编写，由谁编写，如何编写，以及什么是影响期望结果的可用资源和外界因素。 文档等级 对所需文档的一个说明，它指出文档的范围、内容、格式及质量，可以根据项目、费用、预期用途、作用范围或其他因素选择文档等级。 软件产品 软件开发过程的结果，并推出供用户使用的软件实体。 软件文档的作用 ) 管理依据； ) 任务之间联系的凭证； ) 质量保证； ) 培训与参考；(国内标准)GB-软件开发主要文档编写规范
软件开发文档规范
软件开发过程文档规范
软件开发 软件产品开发文件编制指南
软件开发技术文档编写规范
ISO软件开发全套文档~软件开发过程控制程序
软件项目开发计划规范
软件技术文档编写规范
软件过程规范示例
软件文档编写指南
软件测试文件编制规范
ISO软件开发全套文档-配置管理计划编写指南
软件开发过程规范
软件开发文档样式规范
软件设计流程及编写规范
GB 16680-1996 软件文档管理指南
软件开发技术文档编写规范-Read
软件文档管理指南(可编辑修改版).