计算机软件开发文档编写规范.docx
《计算机软件开发文档编写规范.docx》由会员分享，可在线阅读，更多相关《计算机软件开发文档编写规范.docx（23页珍藏版）》请在冰点文库上搜索。
计算机软件开发文档编写规范
封面格式……………………………………………………………………2
封面格式
文档编号
版本号
文档名称：
工程名称：
工程负责人：
编写年月日
校对年月日
审核年月日
批准年月日
开发单位年月日
一.可行性研究报告
1引言
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控制精度或生产能力的提高；d管理信息效劳的改良；e决策系统的改良；f人员工作效率的提高，等等。
】
2.3条件、假定和限制【可包括：
a建议开发软件运行的最短寿命；b进展系统方案选择比拟的期限；c经费来源和使用限制；d法律和政策方面的限制；e硬件、软件、运行环境和开发环境的条件和限制；f可利用的信息和资源；g建议开发软件投入使用的最迟时间。
】
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.4.1对设备的影响
4.4.2对现有软件的影响
4.4.3对用户的影响
4.4.4对系统运行的影响
4.4.5对开发环境的影响
4.4.6对运行环境的影响
4.4.7对经费支出的影响
4.5技术可行性评价【包括：
a在限制条件下，功能目标是否能到达；b利用现有技术，功能目标能否到达；c对开发人员数量和质量的要求，并说明能否满足；d在规定的期限，开发能否完成。
】
5所建议系统经济可行性分析
5.1支出
5.1.1基建投资
5.1.2其他一次性支出
5.1.3经常性支出
5.2效益
5.2.1一次性收益
5.2.2经常性收益
5.2.3不可定量性收益
5.3收益/投资比
5.4投资回收周期
5.5敏感性分析【敏感性分析是指一些关键性因素，如：
系统生存周期长短、系统工作负荷量、处理速度要求、设备和软件配置变化对支出和效益的影响等的分析。
】
6社会因素可行性分析
6.1法律因素【如，合同责任、侵犯专利权、侵犯等问题的分析。
】
6.2用户使用可行性【如，用户单位的行政管理、工作制度、人员素质等能否满足要求。
】
7其他可行性选择的方案
【逐个说明其他可供选择的方案，并重点说明未被推荐的理由。
8结论意见
【结论意见可能是：
a可着手组织开发；b需待假设干条件〔如资金、人力、设备等〕具备后才能开发；c需对开发目标进展某些修改；d不能进展或不必进展〔如技术不成熟，经济上不合算等〕；e其他。
】
二.工程开发方案
1引言
1.1编写目的【说明编写开发方案的目的，指出读者对象。
】
1.2工程背景【可包括：
a工程的委托单位、开发单位主管部门；b该软件系统与其他系统的关系。
】
1.3定义【列出本档中用到的专门术语的定义和缩写词的原文。
】
1.4参考资料【可包括：
a工程经核准的方案任务书、合同或上级机关的批文；b文档所引用的资料、规等；列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。
】
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专题方案要点
【如测试方案、质量保证方案、配置管理方案、人员培训方案、系统安装方案等。
】
三.需求规格说明书
1引言
1.1编写目的【说明编写需求说明书的目的，指明读者对象。
】
1.2工程背景【应包括：
a工程的委托单位、开发单位和主管部门；b该软件系统与其他系统的关系。
】
1.3定义【列出文档中所用到的专门术语的定义和缩写词的原文。
】
1.4参考资料【可包括：
a工程经核准的方案任务书、合同或上级机关的批文；b工程开发方案；c文档所引用的资料、标准和规。
列出这些资料的作者、标题、编号、发表日出版单位或资料来源。
】
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其他需求
【如可使用性、平安、可维护性、可移植性等。
】
四.概要设计说明书
1引言
1.1编写的目的【说明编写概要设计说明书的目的，指明读者对象。
】
1.2工程背景【应包括：
a工程的委托单位、开发单位和主管部门；b该软件系统与其他系统的关系。
】
1.3定义【列出本文档中所用到的专门术语的定义和缩写词的原意。
】
1.4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：
a工程经核准的方案任务书、合同或上级机关的批文；b工程开发方案；c需求规格说明书；d测试方案〔初稿〕；e用户操作手册〔初稿〕；f文档所用的资料、采用的标准或规。
】
2任务概述
2.1目标
2.2运行环境
2.3需求概述
2.4条件与限制
3总体设计
3.1处理流程
3.2总体构造和模块外部设计
3.3功能分配【说明各项功能与程序构造的关系。
】
4接口设计
4.1外部接口【包括用户界面、软件接口与硬件接口。
】
4.2部接口【模块之间的接口。
】
5数据构造设计
5.1逻辑构造设计
5.2物理构造设计
5.3数据构造与程序的关系
6运行设计
6.1运行模块的组合
6.2运行控制
6.3运行时间
7出错处理设计
7.1出错输出信息
7.2出错处理对策【如设置后备、性能降级、恢复及再启动等。
】
8平安设计
9维护设计
【说明为方便维护工作的设施，如维护模块等。
】
五.详细说明书
1引言
1.1编写目的【说明编写详细设计说明书的目的，指明读者对象。
】
1.2工程背景【应包括工程的来源和主管部门等。
】
1.3定义【列出文档中所用到的专门术语的定义各缩写词的原意。
】
1.4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：
a工程的方案任务书、合同或批文；b工程开发方案；c需求规格说明书；d概要设计说明书；e测试方案〔初稿〕；f用户操作手册〔初稿〕；g文档所引用的其他资料、软件开发标准或规。
】
2总体设计
2.1需求概述
2.2软件构造【如给出的软件系统的构造图。
】
3程序描述
【逐个模块给出以下的说明：
】
3.1功能
3.2性能
3.3输入工程
3.4输出工程
3.5算法【模块所选用的算法。
】
3.6程序逻辑【详细描述模块实现的算法，可采用：
a标准流程图；b.PDL语言；c.N-S图；d.PAD；e判定表等描述算法的图表。
】
3.7接口
3.8存储分配
3.9限制条件
3.10测试要点【给出测试模块的主要测试要求。
】
六.用户操作手册
1引言
1.1编写目的【说明编写手册的目的，指明读者对象。
】
1.2工程背景【说明工程来源、委托单位、开发单位及主管部门。
】
1.3定义【列出手册中使用的专门术语的定义和缩写词的原意。
】
1.4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：
a工程的方案任务书、合同或批文；b工程开发方案；c需求规格说明书；d概要设计说明书；e详细设计说明书；f测试方案；g手册中引用的其他资料、采用的软件工程标准或软件工程规。
】
2软件概述
2.1目标
2.2功能
2.3性能
2.3.1数据准确度【包括输入、输出及处理数据的精度。
】
2.3.2时间特性【如响应时间、数据传输时间等。
】
2.3.3灵活性【在操作方式、运行环境需做某些变更时软件的适应能力。
】
3运行情况
3.1硬件【列出软件系统运行所需的硬件最小配置，如a计算机型号、主存容量；b外存储器、媒体、记录格式、设备型号及数量；c输入、输出设备；d数据传输设备及数据转换设备的型号及数量。
】
3.2支持软件【如a操作系统名称及版本号；b语言编译系统或汇编系统的名称及版本号；c数据库管理系统的名称及版本号；d其他必要的支持软件。
】
4使用说明
4.1安装和初始化【给出程序的存储形式、操作命令、反应信息及其含意、说明安装完成的测试实例以及安装所需用软件工具等。
】
4.2输入【给出输入数据或参数的要求。
】
4.2.1数据背景【说明数据来源、存储媒体、出现频度、限制和质量管理等。
】
4.2.2数据格式【如a长度；b格式基准；c标号；d顺序；e分隔符；f词汇表；g省略和重复；h控制。
】
4.2.3输入举例
4.3输出【给出每项输出数据的说明。
】
4.3.1数据背景【说明输出数据的去向、使用频度、存放媒体及质量管理等。
】
4.3.2数据格式【详细说明每一输出数据的格式，如：
首部、主体和尾部的具体形式。
】
4.3.3举例
4.4出错和恢复【给出：
a出错信息及其含意；b用户应采取的措施，如修改、恢复、再启动。
】
4.5求助查询【说明如何操作。
】
5运行说明
5.1运行表【列出每种可能的运行情况，说明其运行目的。
】
5.2运行步骤【按顺序说明每种运行的步骤，应包括：
】
5.2.1运行控制
5.2.2操作信息a运行目的；b操作要求；c启动方法；d预计运行时间；e操作命令格式及说明；f其他事项。
5.2.3输入/输出文件【给出建立或更新文件的有关信息,如:
】a文件的名称及编号；b记录媒体；c存留的目录；d文件的支配【说明确定保存文件或废弃文件的准那么，分发文件的对象，占用硬件的优先级及控制等。
】
5.2.4启动或恢复过程
6非常规过程
【提供给急或非常规操作的必要信息及操作步骤，如出错处理操作、向后备系统切换操作以及维护人员须知的操作和考前须知。
】
7操作命令一览表
【按字母顺序逐个列出全部操作命令的格式、功能及参数说明。
】
8程序文件〔或命令文件〕和数据文件一览表
【按文件名字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。
】
9用户操作举例
七.测试方案
1引言
1.1编写目的【说明编写测试方案的目的并指明读者对象。
】
1.2工程背景【说明工程的来源、委托单位及主管部门。
】
1.3定义【列出测试方案中所用到的专门术语的定义和缩写词的原意。
】
1.4参考资料【列出有关资料的作者、标题、编号恨表日期、出版单位或资料来源，可包括：
a工程的方案任务书、合同或批文；b工程开发方案；c需求规格说明书；d概要设计说明书；e详细设计说书；f用户操作手册；g本测试方案中引用的其他资料、采用的软件开发标准或规。
】
2任务概述
2.1目标
2.2运行环境
2.3需求概述
2.4条件与限制
3方案
3.1测试方案【说明确定测试方法和选取测试用例的原那么。
】
3.2测试工程【列出组装测试和确认测试中每一项测试的容、名称、目的和进度。
】
3.3测试准备
3.4测试机构及人员【测试机构名称、负责人和职责。
】
4测试工程说明
【按顺序逐个对测试工程做出说明：
】
4.1测试工程名称及测试容
4.2测试用例
4.2.1输入【输入的数据和输入的命令。
】
4.2.2输出【预期的输出数据。
】
4.2.3步骤及操作
4.2.4允许偏差【给出实测结果与预期结果之间允许偏差围。
】
4.3进度
4.4条件【给出项测试对资源的特殊要求，如设备、软件、人员等。
】
4.5测试资料【说明项测试所需的资料。
】
5评价
5.1围【说明所完成的各项测试说明问题的围及其局限性。
】
5.2准那么【说明评价测试结果的准那么。
】
八.测试分析报告
1引言
1.1编写目的【说明编写测试方案的目的并指明读者对象。
】
1.2工程背景【说明工程的来源、委托单位及主管部门。
】
1.3定义【列出测试报告中用到的专门术语的定义和缩写词的原意。
】
1.4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：
a工程的方案任务书、合同或批文；b工程开发方案；c需求规格说明书；d概要设计说明书；e详细设计说明书；f用户操作手册；g测试方案；h测试分析报告所引用的其他资料、采用的软件工程标准或软件工程规。
】
2测试方案执行情况
2.1测试工程【列出每一次测试工程的名称、容和目的。
】
2.2测试机构和人员【给出测试机构名称、负责人和参与测试人员。
】
2.3测试结果【按顺序给出每一测试工程的：
a实测结果数据；b与预期结果数据的偏差；c该项测试说明的事实；d该项测试发现的问题。
】
3软件需求测试结论
【按顺序给出每一项需求测试的结论。
包括：
a证实的软件能力；b局限性〔即项需求未得到充分测试的情况及原因〕。
】
4评价
4.1软件能力【经过测试所说明的软件能力。
】
4.2缺陷和限制【说明测试所揭露的软件缺陷和缺乏，以及可能给软件运行带来的影响。
】
4.3建议【提出为弥补上述缺陷的建议。
】
4.4测试结论【说明能否通过。
】
九.开发进度月报
1报告时间及所处的开发阶段
2工程进度
2.1本月的主要活动
2.2实际进展与方案比拟
3所用工时
【按不同层次人员分别计时。
】
4所用机时
【按所用计算机机型分别计时。
】
5经费支出
【分类列出本月经费支出工程，给出支出总额，并与方案比拟。
】
6工作遇到的问题及采取的对策
7本月完成的成果
8下月的工作方案
9特殊问题
十.工程开发总结报告
1引言
1.1编写目的【说明编写总结方案的目的并指明读者对象。
】
1.2工程背景【说明工程的来源、委托单位开发单位及主管部门。
】
1.3定义【列出报告用到的专门术语的定义和缩写词的原意。
】
1.4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：
a工程经核准的方案任务书、合同或上级机关的批文；b工程开发方案；c需求规格说明书；d概要设计说明书；e详细设计说明书；f用户操作手册；g测试方案；h测试分析报告；I本报告引用的其他资料、采用的开发标准或开发规。
】
2开发结果
2.1产品【可包括：
a列出各局部和程序名称、源程序行数〔包括注释行〕或目标程序字节数及程序字节数及程序总计数量、存储形式；b产品文档名称等。
】
2.2主要功能及性能。
2.3所用工时【按人员的不同层次分别计时。
】
2.4所用机时【按所用计算机机型分别计时。
】
2.5进度【给出方案进度与实际进度的比照。
】
2.6费用
3评价
3.1生产率评价【如平均每人每月生产的源程序行数、文档的字数等。
】
3.2技术方案评价
3.3产品质量评价
4经历与教训
十一.程序维护手册
1引言
1.1编写目的【说明编写手册的目的并指明读者对象。
】
1.2开发单位【说明工程的提出者、开发者、用户和使用场所。
】
1.3定义【列出报告用到的专门术语的定义和缩写词的原意。
】
1.4参考资料【列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源以及级别，可包括：
a用户操作手册；b与本工程有关节其他文档。
】
2系统说明
2.1系统用途【说明系统具备的功能，输入和输出。
】
2.2平安【说明系统平安方面的考虑。
】
2.3总体说明【说明系统的总体功能，对系统、子系统和作业做出综合性的介绍，并用图表的方式给出系统主要局部的部关系。
】
2.4程序说明【说明系统中每一程序、分程序的细节和特性。
】
2.4.1程序说明功能
2.4.1.1功能【说明程序的功能。
】
2.4.1.2方法【说明实现方法。
】
2.4.1.3输入【说明程序的输入、媒体、运行数据记录、运行开场时使用的输入数据的类型和存放单元、与程序初始化有关的入口要求。
】
2.4.1.4处理【处理特点的目的，如：
a用图一说明程序的运行和逻辑流程；b程序主要转移条件；c对程序的约束条件；d程序完毕时的出口要求；e与下一程序的通信与联结〔运行、控制〕；f由该程序产生并供处理程序段使用的输出数据类型和存放单元。
g程序运行所用存储量、类型及存储位置等。
】
2.4.1.5输出【程序的输出。
】
2.4.1.6接口【本程序与本系统其他局部的接口。
】
2.4.1.7表格【说明部的各种表、项的细节和特性。
对每表的说明至少包括：
a表的标识符；b使用目的；c使用此表的其他程序；d逻辑划分，如块或部，不包括表项；e表的根本构造；f设计安排，包括表的控制信息。
表目构造细节、使用中的特有性质及各表项的标识、位置、用途、类型、编码表示。
】
2.4.1.8特有的运行性质【说明在用户操作手册中没有提到的运行性质。
】
2.4.2程序2的说明【与程序1的说明一样。
以后其他各程序的说明一样。
】
3操作环境
3.1设备
【逐项说明系统的设备配置及其特性。
】
3.2支持软件
【列出系统使用的运行软件，包括它们的名称和版本号。
】
3.3数据库
【说明每个数据库的性质和容，包括平安考虑。
】
3.3.1总体特征【如a标识符；b使用这些数据库的程序；c静态数据；d动态数据；e数据库的存储媒体；f程序使用数据库的限制。
】
3.3.2构造及详细说明
3.3.2.1说明该数据库的构造，包括其中的记录和项；
3.3.2.2说明记录的组成，包括首部或控制段、记录体；
3.3.2.3说明每个记录构造的字段，包括：
标记或标号、字段的字符长度和位数、该字段的允许值围。
3.3.2.4扩大：
说明为记录构造的字段；
4维护过程
4.1约定
【列出该软件系统设计中所使用全部规那么和约定，包括：
a程序、分程序、记录、字段和存储区的标识或标号助记符的使用规那么；b图表的处理标准、卡片的连接顺序、语句和记号中使用的缩写、出现在图表中的符号；c使用软件技术标准；d标准化数据元素及其特征。
】
4.2验证过程
【说明一个程序段修改后，对其进展验证的要求和过程〔包括测试程序和数据〕及程序周期性验证的过程。
】
4.3出错及纠法
【列出出错状态及其纠法。
】
4.4专门维护过程
【说明文档其他地方没有提到的专门维护过程，如a维护该软件系统的输入输出局部〔如数据库〕的要求、过程和验证方法；b运行程序库维护系统所必需的要求、过程和验证方法；c以闰年、世纪变更所需要的临时性修改等。
】
4.5专用维护程序
【列出维护软件系统使用的后备技术和专用程序〔如文件恢复程序、淘汰过时文件的程序等〕的目录，并加以说明，容包括：
a维护作业的输入输出要求；b输入的详细过程及在硬设备上建立、运行并完成维护作业操作步骤。
】
4.6程序清单和流程图
【引用资料或提供附录给出程序清单和流程图。
】
十二.软件问题报告
1登记号
【由软件配置管理部门为该报告规定一个唯一的、顺序的编号。
】
2登记日期
【软件配置管理部门登记该报告的日期。
】
3问题发现日期
【发现该问题的日期和时间。
】
4活动
【在哪个阶段发现的问题，分为单元测试、组装测试、确认测试和运行维护。
】
5状态
【在软件与配置记录中维护的动态指示，状态表示有a正在复查“软件问题报告〞，以确定将采取什么行动；b“软件问题报告〞已由指定的人进展处理；c修改已完成，并经过测试，正准备交给主程序库；d主程序已经更新，主程库修改的重新测试尚未完成；e做了重新测试，问题再现；f做了重新测试，所做的修改无故障，“软件问题报告〞被关闭；g留待以后关闭。
】
6报告人
【填写“软件问题报告〞人员的、地址、。
】
7问题属于什么方面
【区分是程序的问题，还是模块的问题，或是数据库的问题，文件的问题。
也可以能是它们的某种组合。
】
8模块/子系统
【出现的模块名。
如果不知是哪个模块，可标出子系统名，尽量给出细节。
】
9修订版本号
【出现问题的模块版本。
】
10磁带
【包含有问题的模块的主程序和磁带的标识符。
】
11数据库
【当发现问题时所使用数据库的标识符。
】
12文件号
【有错误的文件的编号。
】
13测试用例
【发现错误时所使用测试用例的标识符。
】
14硬件
【发现错误时所使用的计算机系统的标识。
】
15问题描述/影响
【问题症兆的详细描述。
如果可能，那么写明实际问题的所在。
也要给出该问题对将来测试、接口软件和文件等的影响。
】
16附注
【记载补充信息。
】
十三.软件修改报告
1登记号
【由软件配置管理部门为该报告规定的编号。
】
2登记日期
【软件配置管理部门登记“软件修改报告〞的日期。
】
3时间
【准备好“软件修改报告〞的日期。
】
4报告人
【填写该报告的作者。
】
5子系统名
【受修改影响的子系统名。
】
6模块名
【被修改的模块名。
】
7“软件问题报告〞的编号
【被“软件修改报告〞处理的软件问题或局部处理的“软件软件问题报告〞的编号。
如果某“软件问题报告〞的问题只是局部被处理，那么在编号后附以p,如1234p】
8修改
【包括程序修改、文件更新、数据库修改或它们的组合。
】
9修改描述
【修改的详细描述。
如果是文件更新或数据库修改，还要列出文件更新通知或数据库修改申请的标识符。
】
10批准人
【批准人签字，正式批准进展修改。
】
11语句类型
【程序修改中涉及到的语句类型，包括：
输入/输出语句类、计算语句类、逻辑控制语句类、数据处理语句类〔如数据传送、存取语句类〕。
】
12程序名
【被修改的程序、文件或数据库的名字。
】
13老修订版
【当前的版本/修订本标识。
】
14新修订版
【修改后的版本/修订本标识。
】
15数据库
【如果
升级会员 