软件开发文档规范.docx

《软件开发文档规范.docx》由会员分享，可在线阅读，更多相关《软件开发文档规范.docx（12页珍藏版）》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。

1、软件开发文档规范附 附 2:软件文档编写向导 文档分类 项目包括如下几类文档：项目管理文档。包括：软件项目安排、项目进度报告、项目开发总结报告 软件开发文档。包括：需求规格说明、概要设计说明、具体设计说明、测试安排、软件测试分析报告。产品文档。包括：用户操作手册演示文件。软件项目安排（ SoftwareProjectPlan ）一引言 1编写目的（阐明编写软件安排的目的，指出读者对象。）2项目背景（可包括：（1）项目托付单位、开发单位和主管部门；（2）该软件系统与其他系统的关系。）3定义（列出本文档中用到的特地术语的定义和缩略词的原文。）4参考资料（可包括：文档所引用的资料、规范等；列出资料的

2、作者、标题、编号、发表日期、出版单位或资料来源。）二项目概述 1.工作内容（简要说明项目的各项主要工作,介绍所开发软件的功能性能等.若不编写可行性探讨报告,则应在本节给出较具体的介绍。) 2.条件与限制（阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创建的条件.必要时还应说明用户及分合同承包者担当的工作完成期限及其它条件与限制。）3.产品 （1）程序（列出应交付的程序名称运用的语言及存储形式。）（2）文档（列出应交付的文档。）（3）运行环境（应包括硬件环境软件环境。）4服务（阐明开发单位可向用户供应的服务.如人员培训安装保修维护和其他运行支持。）5验收标准 三实施安排 1任务分解（任务

3、的划分及各项任务的负责人。）2进度（按阶段完成的项目,用图表说明起先时间完成时间。）3预算 4关键问题（说明可能影响项目的关键问题,如设备条件技术难点或其他风险因素,并说明对策。）四人员组织及分工 五交付期限 六专题安排要点（如测试安排等。）项目 开发进 度报告一报告时间及所处的开发阶段 二给出进度 1本周的主要活动 2实际进展与安排比较 三所用工时（按不同层次人员分别计时。）四全部机时 五工作遇到的问题及实行的对策 六本周完成的成果 七下周的工作安排 八特别问题 项目开发总结报告一引言 1编写目的（阐明编写总结报告的目的,指明读者对象。）2项目背景（说明项目的来源、托付单位、开发单位及主管部

4、门。）3定义（列出报告中用到的特地术语定义和缩写词的原意。）4参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目开发安排；（2）需求规格说明书；（3）概要设计说明书；（4）具体设计说明书；（5）用户操作手册；（6）测试安排；（7）测试分析报告（8）本报告引用的其他资料、采纳的开发标准或开发规范。）二开发结果 1产品（可包括：（1）列出各部分的程序名称、源程序行数（包括注释行）或目标程序字节数及程序总计数量、存储形式；产品文档名称等。）2主要功能及性能 3所用工时（按人员的不同层次分别计时。）4所用机时 5进度（给出安排进度与实际进度的对比。）三评价 1生

5、产率评价（如平均每人每周源程序行数、文档的字数等。）2技术方案评价 3产品质量评价 四阅历与教训需求规格说明书（ RequirementsSpecification ）一引言 1编写目的（阐明编写需求说明书的目的,指明读者对象。）2项目背景（可包括：（1）项目的托付单位,开发单位和主管部门；（2）该软件系统与其他系统的关系。）3定义（列出文档中用到的特地术语定义和缩写词的原文。）4参考资料（可包括：（1）项目开发安排；（2）文档所引用的资料，标准和规范。列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。）二任务概述 1目标 2运行环境 3条件与限制 三数据描述 1静态数据 2动态数

6、据（包括输入数据和输出数据。）3数据库描述（给出访用数据库的名称和类型。）4数据词典 5数据采集 四功能需求 1功能划分 2功能描述 五性能需求 1数据精确度 2时间特性（如响应时间、更新处理时间、数据转化与传输时间、运行时间等。）3适应性（在操作方式运行环境与其他软件的接口以及开发安排等发生改变时，应具有的适应实力。）六运行需求 1用户界面（如屏幕格式、报表格式、菜单格式、输入输出时间等。）2硬件接口 3软件接口 4故障处理 七其他需求（如可运用性、平安保密、可维护性、可移植性等。）概要设计说明书（ ArchitecturalDesignSpecification ）一引言 1编写目的（阐明

7、编写概要设计说明书的目的，指明读者对象。）2项目背景（可包括：（1）项目的托付单位,开发单位和主管部门；（2）该软件系统与其他系统的关系。）3定义（列出文档中用到的特地术语定义和缩写词的原意。）4参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目开发安排；（2）需求规格说明书；（3）测试安排（初稿）；（4）用户操作手册（初稿）；（5）文档所引用的资料、采纳的标准或规范。）二任务概述 1目标 2运行环境 3需求概述 4条件与限制 三总体设计 1处理流程 2总体结构和模块外部设计 3功能安排（表明各项功能与程序结构的关系。）四接口设计 1外部接口（包括用户界

8、面软件接口与硬件接口。）2内部接口（模块之间的接口。）五数据结构设计 1逻辑结构设计2物理结构设计 3数据结构与程序的关系 六运行设计 1运行模块的组合 2运行限制 3运行时间 七出错处理设计 1出错输出信息 2出错处理对策（如设置后备、性能降级、复原及再启动等。）八平安保密设计 九维护设计（说明为便利维护工作的设施,如维护模块等。）具体设计说明书（ ProceduralDesignSpecification ）一引言 1编写目的（阐明编写具体设计说明书的目的,指明读者对象。）2项目背景（应包括项目的来源和主管部门等。）3定义（列出文档中用到的特地术语定义和缩写词的原意。）4参考资料（列出这些

9、资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目开发安排；（2）需求规格说明书；（3）概要设计说明书；（4）测试安排(初稿)；（5）用户操作手册(初稿)；（5）文档所引用的其他资料、软件开发标准或规范。）二总体设计 1需求概述 2软件结构（如给出软件系统的结果图。）三程序描述（逐个模块给出以下的说明:：）1功能 2性能 3输入项目 4输出项目 5算法（模块所选用的算法。）6程序逻辑（具体描述模块实现的算法，可采纳:：（1）标准流程图；（2）N-S 图；（3）PAD；（4）判定表等描述算法的图表。）7接口8存储安排 9限制条件 10测试要点（给出测试模块的主要测试要求。）

10、测试安排（ TestPlan ）一、引言 1编写目的（阐明编写测试安排的目的,指明读者对象。）2项目背景（说明项目的来源托付单位及主管部门。）3定义（列出测试安排中用到的特地术语定义和缩写词的原意。）4参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目开发安排；（2）需求规格说明书；（3）概要设计说明书；（4）具体设计说明书；（5）用户操作手册;(6)本测试安排中引用的其他资料采纳的软件开发标准或规范。）二任务概述 1目标 2运行环境 3需求概述 4条件与限制 三安排 1测试方案（说明确定测试方法和选取测试用例的原则。）2测试项目（列出组装测试和确认测试

11、中每一项测试的内容、名称、目的和进度。）3测试打算 4测试机构及人员（测试机构名称负责人和职责。）四测试项目说明（按依次逐个对测试项目做出说明：）1测试项目名称及测试内容 2测试用例 （1）输入（输入的数据和输入的吩咐。）（2）输出（预期的输出数据。）（3）步骤及操作 （4）允许偏差（给出实测结果与预料结果之间允许偏差的范围。）3进度 4条件（给出项测试对资源的特别要求，如设备、软件、人员等。）5测试资料（说明项测试所需的资料。）五评价 1范围（说明所完成的各项测试说明问题的范围及其局限性。）2准则（说明评价测试结果的准则。）测试分析报告（ TestSpecification ）一引言 1编写

12、目的（阐明编写测试分析报告的目的，指明读者对象。）2项目背景（说明项目的来源、托付单位及主管部门。）3定义（列出测试分析报告中用到的特地术语定义和缩写词的原意。）4参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目开发安排；（2）需求规格说明书；（3）概要设计说明书；（4）具体设计说明书；（5）用户操作手册；（6）测试安排；（7）测试分析报告所引用的其他资料、采纳的软件工程标准或软件工程规范。）二测试安排执行状况 1测试项目（列出每一测试项目的名称、内容和目的。）2测试机构和人员（给出测试机构名称、负责人和参加测试人员名单。）3测试结果（按依次给出每一测

13、试项目的：（1）实测结果数据（2）与预期结果数据的偏差（3）该项测试说明的事实（4）该项测试发觉的问题。）三软件需求测试结论 按依次给出每一项需求测试的结论。包括：（1）证明的软件实力（2）局限性（即项需求未得到充分测试的状况及缘由）。四评价 1软件实力（经过测试所表明的软件实力。）2缺陷和限制（说明测试所揭露的软件缺陷和不足,以及可能给软件运行带来的影响。）3建议（提出为弥补上述缺陷的建议。）4测试结论（说明能否通过。）用户操作手册（ UserGuide ）一引言 1编写目的（阐明编写手册的目的，指明读者对象。）2项目背景（说明项目的来源、托付单位、开发单位及主管部门。）3定义（列出手册中用

14、到的特地术语定义和缩写词的原意。）4参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目开发安排；（2）需求规格说明书；（3）概要设计说明书；（4）具体设计说明书；（5）测试安排；（6）手册中引用的其他资料、采纳的软件工程标准或软件工程规范。）二软件概述1目标 2功能 3性能 （1）数据精确度（包括输入、输出及处理数据的精度。）（2）时间特性（如响应时间、处理时间、数据传输时间等。）（3）敏捷性（在操作方式、运行环境需做某些变更时软件的适应实力。）三运行环境 1硬件（列出软件系统运行时所需的硬件最小配置，如：（1）计算机型号、主存容量；（2）外存储器、媒体

15、、记录格式、设备型号及数量；（3）输入、输出设备；（4）数据传输设备及数据转换设备的型号及数量。）2支持软件（如：（1）操作系统名称及版本号；（2）语言编译系统或汇编系统的名称及版本号；（3）数据库管理系统的名称及版本号；（4）其他必要的支持软件。）四运用说明 1安装和初始化（给出程序的存储形式、操作吩咐、反馈信息及其含义、表明安装完成的测试实例以及安装所需的软件工具等。）2输入（给出输入数据或参数的要求。）（1）数据背景（说明数据来源、存储媒体、出现频度、限制和质量管理等。）（2）数据格式（如：（1）长度（2）格式基准（3）标号（4）依次（5）分隔符（6）词汇表（7）省略和重复（8）限制。）

16、（3）输入举例 3输出（给出每项输出数据的说明。）（1）数据背景（说明输出数据的去向、运用频度、存放媒体及质量管理等。）（2）数据格式（具体阐明每一输出数据的格式,如:首部主体和尾部的详细形式。）（3）举例 3出错和复原（给出：（1）出错信息及其含义（2）用户应实行的措施，如修改、复原、再启动。）4求助查询（说明如何操作。）五运行说明 1运行表列出每种可能的运行状况,说明其运行目的. 2运行步骤按依次说明每种运行的步骤,应包括: （1）运行限制 （2）操作信息（1）运行目的（2）操作要求（3）启动方法（4）预料运行时间（5）操作吩咐格式及说明（6）其他事项。）（3）输入/输出文件（给出建立和更新文件的有关信息，如：（1）文件的名称及编号（2）记录媒体（3）存留的书目（4）文件的支配（说明确定保留文件或废弃文件的准则，分发文件的对象，占用硬件的优先级及保密限制等。）（4）启动或复原过程 六特别规过程 （供应应急或特别规操作的必要信息及操作步骤，如出错处理操作、向后备系统切换操作以及维护人员须知的操作和留意事项。）七操作吩咐一览表（按字母依次逐个列出全部操作吩咐的格式功能及参数说明。）八程序文件（或吩咐文件）和数据文件一览表 （按文件名字母依次或按功能与模块分类依次逐个列出文件名称、标识符及说明。）九用户操作举例