软件说明书编写指南

概要设计说明书（Architectural Design Specification）

一． 引言

1． 编写目的（阐明编写概要设计说明书的目的，指明读者对象。）

2． 项目背景（可包括：（1）项目的委托单位,开发单位和主管部门；（2）该软件系统与其他系统的关系。）

3． 定义（列出文档中用到的专门术语定义和缩写词的原意。）

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

二． 任务概述

1． 目标

2． 运行环境

3． 需求概述

4． 条件与

三． 总体设计

1．处理流程

2．总体结构和模块外部设计

3．功能分配（表明各项功能与程序结构的关系。）

四． 接口设计

1． 外部接口（包括用户界面 软件接口与硬件接口。）

2． 内部接口（模块之间的接口。）

五． 数据结构设计

1． 逻辑结构设计

2． 物理结构设计

3． 数据结构与程序的关系

六． 运行设计

1． 运行模块的组合

2． 运行控制

3． 运行时间

七． 出错处理设计

1． 出错输出信息

2． 出错处理对策（如设置后备、性能降级、恢复及再启动等。）

八． 安全保密设计

九． 维护设计（说明为方便维护工作的设施,如维护模块等。）

注意：1.说明书中（文字和截图）出现的软件名称须与采集表、源代码中出现的软件名称保持一致；

2.如果是一个大型系统分开为几个小系统分开登记备案的，每个系统的提供的说明书和源代码尽量不要一样，否则影响审批程序。

源代码指南

1.源代码每行开头要标准；

2.请根据源代码填写采集表中的编程语言，若用了多个语言， 请用“；”分开都写上；

3.源代码每页调整为50行，均居左，行与行之间尽量不要空行。若调整后整个源代码不满60页，全部提供。全部源代码超过60页的，截取全部源代码的前、后各30页。采集表中的源程序量根据（？*50行=？）如实写上；

4.源代码中出现的软件名称要与采集表和说明书中保持一致。