软件开发文档规范.doc

附2:
软件文档编写向导
文档分类
项目包括如下几类文档:
项目管理文档。包括:《软件项目计划》、《项目进度报告》、《项目开发总结报告》
软件开发文档。包括:《需求规格说明》、《概要设计说明》、《详细设计说明》、《测试计划》、《软件测试分析报告》。
产品文档。包括:《用户操作手册》《演示文件》。
软件项目计划
(Software Project Plan)
 
(阐明编写软件计划的目的,指出读者对象。)
(可包括:(1)项目委托单位、开发单位和主管部门;(2)该软件系统与其他系统的关系。)
(列出本文档中用到的专门术语的定义和缩略词的原文。)
(可包括:文档所引用的资料、规范等;列出资料的作者、标题、编号、发表日期、出版单位或资料来源。)

1.    工作内容(简要说明项目的各项主要工作,介绍所开发软件的功能性能等. 若不编写可行性研究报告,则应在本节给出较详细的介绍。)
2.    条件与限制(阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的条件. 必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。)
3.    产品
   (1)程序(列出应交付的程序名称使用的语言及存储形式。)
     (2)文档(列出应交付的文档。)
     (3)运行环境(应包括硬件环境软件环境。)
(阐明开发单位可向用户提供的服务. 如人员培训安装保修维护和其他运行支持。)


(任务的划分及各项任务的负责人。)
(按阶段完成的项目,用图表说明开始时间完成时间。)

(说明可能影响项目的关键问题,如设备条件技术难点或其他风险因素,并说明对策。)


(如测试计划等。)
项目开发进度报告 


1. 本周的主要活动
2. 实际进展与计划比较
(按不同层次人员分别计时。)





项目开发总结报告 

(阐明编写总结报告的目的,指明读者对象。)
(说明项目的来源、委托单位、开发单位及主管部门。)
(列出报告中用到的专门术语定义和缩写词的原意。)
(列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源,可包括:(1)项目开发计划;(2)需求规格说明书;(3)概要设计说明书;(4)详细设计说明书;(5)用户操作手册;(6)测试计划;(7)测试分析报告(8)本报告引用的其他资料、采用的开发标准或开发规范。)

1. 产品(可包括:(1)列出各部分的程序名称、源程序行数(包括注释行)或目标程序字节数及程序总计数量、存储形式;产品文档名称等。)
2. 主要功能及性能
3. 所用工时(按人员的不同层次分别计时。)
4. 所用机时
5. 进度(给出计划进度与实际进度的对比。)

(如平均每人每周源程序行数、文档的字数等。)