软件的开发文档编写要求
软件开发文档编写要求
在项目开发过程中，应该按要求编写好十三种文档，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。
◇可行性分析报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。
◇项目开发计划：为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。
◇软件需求说明书（软件规格说明书）：对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。
◇概要设计说明书：该说明书是概要实际阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计提供基础。
◇详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。
◇用户操作手册：本手册详细描述软件的功能、性能和用户界面，使用户对如何使用该软件得到具体的了解,为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。
◇测试计划：为做好集成测试和验收测试，需为如何组织测试制订实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。
◇测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。
◇开发进度月报：该月报系软件人员按月向管理部门提交的项目进展情况报告，报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。
◇项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力，此外，还需对开发工作做出评价，总结出经验和教训。
◇软件维护手册：主要包括软件系统说明、程序模块说明、操作环境、支持软件的说明、维护过程的说明，便于软件的维护。
◇软件问题报告：指出软件问题的登记情况，如日期、发现人、状态、问题所属模块等，为软件修改提供准备文档。
◇软件修改报告：软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响作出详细的描述，提交审批。
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 资源
完成修改所需资源的估计，即总的人时数和计算机时间的开销。
程序流程图编写规范_(终极整理版)
程序流程图规范 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. 控制精度或生产能力的提高。 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输入输出的要求 解释各输入输出的数据类型，并逐项说明其媒体、格式、数值范围、精度等。 对软件的数据输出及必须标明的控制输出量进行解释并举例，包括对硬拷贝报 附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.1服务器上有关数据库的一切操作只能由服务器管理人员进行。 1.2程序中访问数据库时使用统一的用户、统一的连接文件访问数据库。 1.3原则上每一个频道只能建一个库，库名与各频道的英文名称相一致，库中再包含若干表。比较大的、重点的栏目可以考虑单独建库，库名与栏目的英文名称相一致。 1.4命名： （1）数据库、表、字段、索引、视图等一系列与数据库相关的名称必须全部使用与内容相关的英文单词命名（尽量避免使用汉语拼音），对于一个单词难以表达的，可以考虑用多个单词加下划线（_）连接（不能超过四个单词）命名。 （2）所有的名称必须统一使用英文小写字母。 （3）所有的名称起始和结尾不能使用下划线（_）。 （4）所有的名称不能包含26个英文小写字母和下划线（_）以外的其他字符。 1.5不再使用的数据库、表应删除，在删除之前必须备份（包括结构和内容）。 2、文档规范 所有的项目必须有相关的文档说明（可以是电子文档）。文档应包含如下内容： （1）项目名称。 （2）项目小组名单，项目负责人。 （3）项目开发起始时间和结束时间。 （4）项目内容描述。 （5）项目位置。（在哪个频道、哪个栏目） （6）与项目有关的程序文件名（含路径名），文件内容及实现的功能描述。 （7）完整的程序流程图。 （8）数据库、表、视图、索引的名称，用途。字段的名称、类型、长度、用途，必须附上相关的SQL语句。 3、源代码与页面嵌套规范 3.1源代码： （1）使用自定义变量（包括全局变量、局部变量）之前必须先声明变量，并用注释语句标明变量的类型、用途。 （2）自定义函数必须用注释语句标明函数的用途、参数的数据类型、意义，返回值的类型。 （3）程序中重要的过程或代码较长的过程应使用注释语句标明该过程的起始行和结束行，并注明该过程的功能。 （5）所有的注释文字一律使用简体中文。 3.2 HTML页面嵌套： （1）网页设计部设计的HTML页面以嵌套的方式确定用于动态显示程序执行结果的位置、宽度、行数（或高度）等，并在相应位置予以文字说明。页面中与程序无关的图片、文字、联结等必须使用完整的URL。 （2）软件开发人员和编辑人员可以根据情况协商，将页面文件及图片与程序独立存放在各自的服务器上，页面改版和修改程序独立进行。 （3）使用include技术将分割开的HTML页面分别嵌入程序代码中，要求做到修改HTML页面时无须改写程序，而修改程序时不会影响HTML页面效果，将页面改版和修改程序两项工作分别独立。 （4）页面和程序嵌套以后不能破坏原HTML页面的整体显示效果，字体、字号、颜色等应尽量保持原HTML页面的风格。 （5）动态生成的页面的各项指标（如图片大小、页面宽度、高度、页面文件的字节数等）应符合本公司网页设计方面的要求。 4、测试规范（软件部分） 对于较大的项目应成立相应的测试小组，小组成员由软件开发人员、网页设计人员、技术人员、 《计算机软件文档编写指南》 一．计算机软件文档由封面、目录、正文、注释和附录组成。 封面格式： 密级：编号： 文档名称： 项目名称： 编制： 审核： 批准： ×××××××××××××研究所 年月日 二．计算机软件文档包括： 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背景 ? 表示待开发的软件系统的名称、代码； ? 列出本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络； ? 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.总则 最大限度提高Q&P（质量与生产率），提高Q&P的可预见性，是每一个软件开发机构的最大目标。而Q&P依赖于三个因素：过程、人和技术，因此要实现Q&P的提高，除了加强技术能力，引进、培育更多优质技术人才之外，规范、改进机构的过程是一个十分重要的手段。我们希望通过在制定软件过程规范标准，并在软件开发实践中不断地完善、修订，提高Q&P和Q&P的可预见性。 本规范采用CMM（软件过程成熟度模型）的指导，吸收RUP、XP、MSF、PSP、TSP等过程规范指南的思想、方法及实践，充分结合xxx 技术开发部的实际情况，引入先进的技术、方法、工具，为公司的软件开发工作提供一部详细、可操作的过程指南。在本规范的第一版本中，主要包括管理过程和开发过程两个部分，管理过程中包括项目管理过程、需求变更管理过程、配置管理过程。对于软件开发项目中的其它的一些过程将在实践中逐步补充、完善。 2.项目管理过程规范 项目管理过程主要包括三个阶段：项目立项与计划、项目实施、项目关闭。 项目立项与计划 参与人员：技术开发部指定的项目负责人（包括前期负责人、正式的项目经理）、立项申请人、[相关最终客户]以及实施该项目的开发组队成员； 入口准则：接到经公司总经理或副总经理批准的市场部门的《软件开发立项申请表》； 出口准则：立项申请人签字确认了经修订正后的正式《软件项目计划》，并通过《工作任务卡》下达了开发任务，开发工作正式开始；输入：经审批的《软件开发立项申请表》、与需求相关的业务资料；输出：《软件项目计划》、《软件需求规格说明书》、《开发任务卡》；活动： 接到《软件开发立项申请表》后，技术开发部经理指定前期负责人，并告知立项申请人； 前期负责人阅读《软件开发立项申请表》后，通过与立项申请人的沟通、阅读立项申请人提交的材料、通过立项申请人与客户直接交流 软件开发文档模板库 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.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 概述 软件开发过程规范 第一部分软件需求分析规范 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人员培训 针对所选定的设计方法和工具，以及相关的标准对需求人员进行相应的培训。这是一个可选项，但对于新的方法和工具，或新的分析人员，培训是必需的。 软件文档编写指南 封面格式： 文档编号 版本号 文档名称： 项目名称： 项目负责人： 编写年月日 校对年月日 审核年月日 批准年月日 开发单位 系统规约说明书（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．技术可行性 本软件拟决定最终在分布式系统上来运行。硬件方面，由于广东传讯网络信息有限公司是国外多 一、前期方案评估 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 任务进度安排 指定软件编写责任人以及进度表。相应文档规整，责任人签字确认后存档。 神州数码（中国）有限公司 秘级：内部保密文件仅限内部使用 概要设计说明书模板 （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) 软件项目开发和管理规范 本文阐述软件项目开发和管理的流程规范，作为软件项目开发的高级指引，本规范定义了软件开发的各个阶段以及每个阶段的工作活动和工件，但不对活动和工件的细节作过多规定。在项目开发过程中，每个项目根据自身的需要确定这些活动和工件的细节。 项目阶段 图2-1 项目开发的五个阶段 ?启动阶段 这个阶段的工作目的是决定一个项目是否需要启动。为了达到这个目的，首先要明确项目的总体战略目标，对项目的需要建立认同。即确定到底需要做什么、开发什么产品或提供什么服务，以及需要解决什么样的问题和需要满足客户或市场的什么要求等，同时还要总结项目工作的范围、所需资源、大约开支、各种风险，以及该项目不执行的其他替代选择等。这些代表了对整个项目目标从战略角度和宏观层次所进行的分析，通过项目的意向书总结出来，由此确证客户或项目发起人和赞助者的要求与期望，并帮助他们判定项目是否上马。项目意向总结书的通过及项目被批准上马形成了这个项目的起始点。 ?计划阶段 这个阶段的工作是为整个项目做计划。项目开始后，首先要确定项目的具体范围，明确定出项目到底要做什么，总结、归纳并定出产品的功能。然后进一步制定项目的计划，列出每项具体工作，并建立所有工作任务的重要性及顺序；确定每项工作的执行人和所需资源；根据人员的配置和能力设定各项工作和整个项目的完成时间表。 ?执行阶段 这个阶段的工作是通过执行项目的计划来完成项目的任务。它包括落实一切所需资源，如：人员、设备、费用、技术、信息，由管理者领导全体项目参与者开展各项工作。同时跟踪各项具体工作和整个项目的进度，定期向全体项目人员及项目的发起人报告项目状态。 ?控制阶段 这个阶段的工作是确证项目工作的结果符合项目的计划。它通过对项目结果的衡量和审核，与项目计划所期望的结果进行比较，找出实际结果与计划的差别，并制定处理措施。这个阶段的工作还包括对项目进程中出现的任何更改要求进行审核和批准。同时调解项目进程中出现的各种问题，如：对缺乏的资源的补偿调节；对项目的进度表及各项具体工作的优先级或顺序的修订。 ?结束阶段 这个阶段的工作是确保项目的最终结果或提交物达到计划的要求，并对完成的结果作可接受的确认。还包括在项目完成之后的收尾工作，对整个项目的经历进行总结，修订项目文档，用户培训等。 阶段完成标志 在项目开发过程中，当一个阶段完成后才会开展下一个阶段的工作；另外，“某个阶段完成”通常被定义为项目的一个里程碑，里程碑标识了项目的进度，它是项目开发和控制的重要参考，对整个项目有重要的意义。因此，“确证某个阶段是否已经完成”的工作非常有重要。 ?每一个阶段的结束以它特定任务的完成为象征 只有当某个阶段中被规定的所有工作任务都完成了，这个阶段才算真正结束，整个项目才可以进入到下一个阶段中去。反过来说，要是阶段中某个任务没有全部完成，按照项目的定义，整个阶段就不能算是完成，因此项目就不能进入到下一个阶段去。 ?衡量阶段结束的工作结果必须是实在的交付品 阶段中的任务是否完成是透过任务活动中产生的交付品来体现的，交付品必须是可交付的、非抽象的、实质的并且可以通过用衡量的方法来判断是否真正地完成了的具体事物。如：某一阶段的完成是以建造一个样品或完成某分文件作为象征。任何项目阶段的结束，都应该有这样的实质性东西的完成作为象征。 ?跨阶段的进程以阶段结尾的合格验证和审核来决定 当一个阶段结束时，在进入到下一个阶段之前所需要做的工作应包括对交付品进行合格验证，并检查这一阶段的工作质量和效率，由此判断是否可以进入到下一个阶段。这些检验象征了一个阶段的结尾终点，表示项目的进程离开了上一个阶段而进入了下一个阶段。 附录五国家标准《计算机软件产品开发文件编制指南》国家标准《计算机软件产品开发文件编制指南》（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、数据库设计说明书(国内标准)GB-软件开发主要文档编写规范
软件开发过程文档规范
软件开发文档规范
软件开发技术文档编写规范
软件系统开发规范
计算机软件文档编制规范
软件项目开发计划规范
软件过程规范示例
软件开发文档模板库
软件测试文件编制规范
软件开发过程规范
软件开发设计文档模板
软件开发文档样式规范
软件设计流程及编写规范
软件开发技术文档编写规范-Read
软件开发规划项目规范标准
软件开发软件产品开发文件编制指南