软件文档编写指南

《软件文档编写指南》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、《计算机软件文档编写指南》一．计算机软件文档由封面、目录、正文、注释和附录组成。封面格式：密级：编号：文档名称：项目名称：编制：审核：批准：×××××××××××××研究所年月日二．计算机软件文档包括：1）软件开发计划2）软件需求规格说明3）接口需求规格说明4）接口设计文档5）软件设计文档6）软件产品规格说明7）版本说明文档8）软件测试计划9）软件测试说明10）软件测试报告11）计算机系统操作员手册12）软件用户手册13）软件程序员手册14）计算机资源综合保障文件软件开发计划一．引言1．编写目的（阐明编写软件计划的目的，指出读者对象。）2．项目背

2、景（可包括：（1）项目委托单位、开发单位和主管部门；（2）该软件系统与其他系统的关系。）3．定义（列出本文档中用到的专门术语的定义和缩略词的原文。）4．参考资料（可包括：（1）项目经核准的计划任务书、合同或上级机关的批文；（2）文档所引用的资料、规范等；列出资料的作者、标题、编号、发表日期、出版单位或资料来源。）二．项目概述1.工作内容（简要说明项目的各项主要工作,介绍所开发软件的功能性能等.若不编写可行性研究报告,则应在本节给出较详细的介绍。)2.条件与限制（阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的条件.必要时还应说明用户及

3、分合同承包者承担的工作完成期限及其它条件与限制。）3.产品（1）程序（列出应交付的程序名称使用的语言及存储形式。）（2）文档（列出应交付的文档。）（3）运行环境（应包括硬件环境软件环境。）4．服务（阐明开发单位可向用户提供的服务.如人员培训安装保修维护和其他运行支持。）1．验收标准三．实施计划1．任务分解（任务的划分及各项任务的负责人。）2．进度（按阶段完成的项目,用图表说明开始时间完成时间。）3．预算4．关键问题（说明可能影响项目的关键问题,如设备条件技术难点或其他风险因素,并说明对策。）四．人员组织及分工五．交付期限六．专题计划要点（如测试计

4、划质量保证计划配置管理计划人员培训计划系统安装计划等。）软件需求规格说明一．引言1．编写目的（阐明编写需求说明书的目的,指明读者对象。）2．项目背景（可包括：（1）项目的委托单位,开发单位和主管部门；（2）该软件系统与其他系统的关系。）3．定义（列出文档中用到的专门术语定义和缩写词的原文。）4．参考资料（可包括：（1）项目经核准的计划任务书,合同或上机机关的批文；（2）项目开发计划；（3）文档所引用的资料，标准和规范。列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。）二．任务概述1．目标2．运行环境3．条件与限制三．数据描述1．静态

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

6、明编写概要设计说明书的目的，指明读者对象。）2．项目背景（可包括：（1）项目的委托单位,开发单位和主管部门；（2）该软件系统与其他系统的关系。）3．定义（列出文档中用到的专门术语定义和缩写词的原意。）4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目经核准的计划任务书，合同或上机机关的批文；（2）项目开发计划；（3）需求规格说明书；（4）测试计划（初稿）；（5）用户操作手册（初稿）；（6）文档所引用的资料、采用的标准或规范。）二．任务概述1．目标2．运行环境3．需求概述4．条件与限制三．总体设计1．处理

7、流程2．总体结构和模块外部设计3．功能分配（表明各项功能与程序结构的关系。）四．接口设计1．外部接口（包括用户界面软件接口与硬件接口。）2．内部接口（模块之间的接口。）一．数据结构设计1．逻辑结构设计2．物理结构设计3．数据结构与程序的关系二．运行设计1．运行模块的组合2．运行控制3．运行时间三．出错处理设计1．出错输出信息2．出错处理对策（如设置后备、性能降级、恢复及再启动等。）四．安全保密设计五．维护设计（说明为方便维护工作的设施,如维护模块等。）详细设计说明书一．引言1．编写目的（阐明编写详细设计说明书的目的,指明读者对象。）2．项目背景（

8、应包括项目的来源和主管部门等。）3．定义（列出文档中用到的专门术语定义和缩写词的原意。）4．参考资料（列出这些资料的作者、标题、编号、发