软件的开发文档要求规范.pdfVIP

软件的开发文档要求规范--第1页

附2:

软件文档编写向导

文档分类

项目包括如下几类文档：

项目管理文档。包括：《软件项目计划》、《项目进度报告》、《项目开发总结报告》

软件开发文档。包括：《需求规格说明》、《概要设计说明》、《详细设计说明》、《测试

计划》、《软件测试分析报告》。

产品文档。包括：《用户操作手册》《演示文件》。

软件项目计划

〔SoftwareProjectPlan〕

一．引言

1．编写目的〔说明编写软件计划的目的，指出读者对象。〕

2．项目背景〔可包括：〔1〕项目委托单位、开发单位和主管部门；〔2〕该软件系统与其

他系统的关系。〕

3．定义〔列出本文档中用到的专门术语的定义和缩略词的原文。〕

4．参考资料〔可包括：文档所引用的资料、规X等；列出资料的作者、标题、编号、发表

日期、单位或资料来源。〕

二．项目概述

1.工作内容〔简要说明项目的各项主要工作,介绍所开发软件的功能性能等.假如不编写

可行性研究报告,如此应在本节给出较详细的介绍。)

2.条件与限制〔说明为完成项目应具备的条件开发单位已具备的条件以与尚需创造的条

件.必要时还应说明用户与分合同承包者承当的工作完成期限与其它条件与限制。〕

3.产品

〔1〕程序〔列出应交付的程序名称使用的语言与存储形式。〕

〔2〕文档〔列出应交付的文档。〕

〔3〕运行环境〔应包括硬件环境软件环境。〕

4．服务〔说明开发单位可向用户提供的服务.如人员培训安装保修维护和其他运行支持。〕

5．验收标准

软件的开发文档要求规范--第1页

软件的开发文档要求规范--第2页

三．实施计划

1．任务分解〔任务的划分与各项任务的负责人。〕

2．进度〔按阶段完成的项目,用图表说明开始时间完成时间。〕

3．预算

4．关键问题〔说明可能影响项目的关键问题,如设备条件技术难点或其他风险因素,并说明

对策。〕

四．人员组织与分工

五．交付期限

六．专题计划要点〔如测试计划等。〕

项目开发进度报告

一．报告时间与所处的开发阶段

二．给出进度

1．本周的主要活动

2．实际进展与计划比拟

三．所用工时〔按不同层次人员分别计时。〕

四．所有机时

五．工作遇到的问题与采取的对策

六．本周完成的成果

七．下周的工作计划

八．特殊问题

项目开发总结报告

一．引言

1．编写目的〔说明编写总结报告的目的,指明读者对象。〕

2．项目背景〔说明项目的来源、委托单位、开发单位与主管部门。〕

3．定义〔列出报告中用到的专门术语定义和缩写词的原意。〕

4．参考资料〔列出资料的作者、标题、编号、发表日期、单位或资料来源，可包括：〔1〕项

目开发计划；〔2〕需求规格说明书；〔3〕概要设计说明书；〔4〕详细设计说明书；〔5〕

用户操作手册；〔6〕测试计划；〔7〕测试分析报告〔8〕本报告引用的其他资料、采用的

开发标准或开发规X。〕

软件的开发文档要求规范--第2页

软件的开发文档要求规范--第3页

二．开发结果

1．产品〔可包括：〔1〕列出各局部的程序名称、源程序行数〔包括注释行〕或目标程序字节