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

一、项目开发计划
1．引言 1
1
1
2
2
2．项目概述 2
2
2
2
2
3
3
3
3
3．总体设计 3
3
3
3
4．接口设计 3
3
3
5．数据结构设计 3
3
3
3
6．运行设计 3
3
3
3
7．出错处理设计 3
3
3
3
3
1．引言

【阐明编写概要设计说明书目，指明读者对象。】

【应包括：
项目委托单位、开发单位和主管部门；
该软件系统和其他系统关系。】

【列出本文档中所用到专门术语定义和缩写词原文。】

【列出有关资料作者、标题、编号、发表日期、出版单位或资料来源，可包括：
项目经核准计划任务书、合同或上级机关批文；
项目开发计划；
需求规格说明书；
测试计划（初稿）；
用户操作手册（初稿）；
文档所引用资料、采用标准或规范。】
2．任务概述




3．总体设计



【表明各项功能和程序结构关系。】
4．接口设计

【包括用户界面、软件接口和硬件接口。】

【模块之间接口。】
5．数据结构设计



6．运行设计



7．出错处理设计


【如设置后备、性能降级、恢复及再启动等。】


【说明为方便维护工作设施，如维护模块等。】
四、详细设计说明书
1．引言 1
1
1
2
2
2．总体设计 2
2
2
3．程序描述 2
3
3
3
3
3
3
3
3
3
3
1．引言

【阐明编写详细设计说明书目，指明读者对象。】

【应包括项目来源和主管部门等。】

【列出文档中所用到专门术语定义和缩写词原文。】

【列出有关资料作者、标题、编号、发表日期、出版单位或资料来源，可包括：
项目计划任务书、合同或批文；
项目开发计划；
需求规格说明书；
概要设计说明书；
测试计划（初稿）；
用户操作手册（初稿）；
文档中所引用其他资料、软件开发标准或规范。】
2．总体设计


【如给出软件系统结构图。】
3．程序描述
【逐个模块给出以下说明：】





【模块所选用算法。】

【详细描述模块实现算法，可采用：
标准流程图；
PDL语言；
N－S图；
PAD；
判定表等描述算法图表。】




【给出测试模块主要测试要求。】
五、用户操作手册
1．引言 1
1
2
2
2
2．软件概述 2
2
2
2
3．运行环境 2
2
3
3
3
3
3
3
3
3
3
3
3
3
（或命令文件）和数据文件一览表 3
3
1．引言

【阐明编写手册目，指明读者对象。】

【应包括项