详细设计说明书-模板.doc

北京锐安科技有限公司 项目名称

Ver201403第PAGE2页共NUMPAGES14页

文档作者：

文档呈送：

文档抄送：

XX项目

详细设计说明书

VX.Y

编写：

审核：

批准：

参与评审：

变更记录

版本号

变化状态

修改点说明

变更人

存放位置

审批人

审批日期

*变化状态：C――创建，A——增加，M——修改，D——删除

修改点说明：对变化状态进行简单解释，如增加了某项功能，修改了某个模块等信息。不允许出现“根据评审意见修改等字样”

注：当文档未评审通过前版本号标识规则为V0.X,第一次评审通过后，版本号直接升级为V1.0，之后变更按照V1.X升级。

目录

TOC\o1-3\h\z1 前提和约束 4

编写目的 4

预期读者和阅读建议 4

定义、缩写词、略语 4

参考资料 5

2 前提和约束 6

前提条件 6

限制和约束 6

3 综合描述 6

3.1 系统目标 6

3.2 系统需求 6

3.3 系统概述 7

3.4 程序结构说明 7

3.5 源程序及编译链接组装说明 7

4 系统详细设计 7

4.1 XXX子系统名称 8

4.1.1 XXX包名称 9

4.2 XXX子系统名称2 10

5 用户界面详细设计（可裁剪） 10

5.1 界面结构 11

5.1.1 界面结构或菜单结构 11

5.1.2 用户界面图（如无此需要，可省略） 11

5.2 界面处理流程及界面约束描述（如无此需要，可省略） 11

5.2.1 界面或模块名1 11

5.2.2 处理流程 11

5.2.3 界面约束与事件约束 11

5.2.4 触发方式 11

5.2.5 界面或模块名2 11

6 尚未解决的问题 12

7 资源对象说明 12

文档简介

[说明]

本部分要描述文档的目的，帮助读者对本文档建立基本印象，并为阅读后续内容扫清障。

蓝色字体部分是文档的说明，请各位同事在完成文档撰写后删除该部分。

编写目的

[说明]

本部分主要阐述文档目的，而非项目目的。否则造成同一项目多个文档之间的内容重复，不利于文档维护。

预期读者和阅读建议

[说明]

指定需要认真阅读此文档的人员。本小节应指明文档针对的读者对象，最好列出各种读者角色，并说明每种读者角色应该重点阅读的章节。

指明文档组织方式，简要描述各文档各部分关注的内容和解决的问题。

定义、缩写词、略语

[说明]

按字母或拼音顺序列出所有的定义和缩略语，以便读者可以正确地理解《架构设计说明书》，包括词头和缩写。注意：只需要列出对理解本文有用的术语。

序号

术语/缩略语

说明/定义

英文全称

中文译名

1

2

3

...

参考资料

[说明]

列举编写《架构设计说明书》时所参考的资料或其它来源。包括但不限于：用户界面风格指导、合同、标准、系统需求规格说明书、用户需求、相关产品的产品需求规格说明书等。可根据项目的实际情况选择参考资料的范围，但至少应包括用户需求说明书和需求分析说明书。

作者

文献名称

出版单位（或归属单位）

版本或日期

前提和约束

前提条件

[说明]

对详细设计工作依赖的上游文档做说明。可使用表格或文字进行简要说明，没有的项目写无。

类别

文件名称

主要依据章节及内容

是否完全依据

需求

是

架构

是

概要设计

是

其他前提条件

是

特殊情况说明：

限制和约束

[说明]

阐述应遵循的重要限制和约束，包括技术条件、软硬件条件、功能、性能目标约束等。

综合描述

系统目标

[说明]

系统最终要解决的实际问题或要达到的用户要求，系统如何能够做到客户满意。

系统需求

[说明]

系统由上游文档规定的需求的简要说明。说明本系统，本文档涵盖的需求及功能实现部分。

系统概述

[说明]

简述系统功能，映射详细设计的基础轮廓。用系统结构图表示系统内的包和主要类的名称、标识符和它们之间的层次结构关系，可以以系统体系结构划分，也可以由类类别划分(边界类、控制类、助手类、实体类、数据类)，甚至可以由功能结构划分。

程序结构说明

[说明]

结合上游文件中的逻辑视图，描述最终的程序划分、结构图及功能与调用关系简要说明、程序种