计算机软件开发文档编写指南

http://www.cnsia.com/zygx/zygx01.htm#1

一、项目开发计划	二、需求规格说明书	三、概要设计说明书
四、详细设计说明书	五、用户操作手册	六、测试计划
七、测试分析报告	八、开发进度月报	九、项目开发总结报告
十、程序维护手册	十一、软件问题报告	十二、软件修改报告

一、项目开发计划

　　 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．专题计划要点
　　【如测试计划、质量保证计划、配置管理计划、人员培训计划、系统安装计划等。】