详细设计项目说明指导书模版.docVIP

密级：机密

文档编号：XXX_TS_TEMP_XXSJSMS

版本号：V2.0

【项目名称】

具体设计说明书模板

编写人：

XXX

同意人：

XXX

生效日期：

1月6日

版权信息

本文件包含之信息，属XXX全部。

未经XXX许可，

文件中任何部分全部不能以任何形式向第三方散发。

文档修订统计

版本号

修订日期

修订人

修订说明

修订状态

审核日期

审核人

同意人

V0.1

-12-1

XXX

创建

A

-12-1

XXX

XXX

V1.0

-12-28

XXX

调整需求分析方法

M

-12-29

XXX

XXX

V2.0

-1-4

XXX

更换使用模板

M

-1-6

XXX

XXX

修订状态：A--增加，M--修改，D--删除

日期格式：YYYY-MM-DD

目录

TOC\o1-3\h\z\u1 概述 1

1.1 编写目标 1

1.2 适用范围 1

1.3 术语和缩写 1

1.4 参考资料 1

2 角色和职责 1

3 设计约定 1

4 实现架构及功效逻辑 1

4.1 功效逻辑描述 1

4.1.1功效模块结构图 2

4.1.2功效模块描述 2

4.2 软件体系架构 3

4.2.1设计思绪 3

4.2.2包图及描述 4

4.2.3类图及描述 5

4.2.4关键程序描述 6

4.2.5组件图及描述 6

4.2.6源代码目录结构 7

4.2.7权限设计 7

4.3 总体界面设计 8

4.3.1设计标准 8

4.3.2设计思绪 8

4.3.3界面风格 8

4.3.4界面层次图 8

4.3.5界面原型 8

5 具体设计 8

5.1 模块A 9

5.1.1概要说明 9

5.2.2实现框架 10

5.3.3关键逻辑实现描述： 11

5.3.4界面设计 13

5.3.5接口设计 13

5.3.6其它 13

5.2 模块B 14

6 数据库设计 14

7 接口设计 14

8 附录： 14

概述

编写目标

此处填写本文档目标

比如：XXX项目标目标是：依据《XXX需求规格说明书》进行具体设计

适用范围

此处填写本文档适用范围等

术语和缩写

此处填写本文档中所特有术语和缩写，常见术语和缩写统一编写在一个规范文档中

术语和缩写

解释

备注

参考资料

指出为完成本文档所需要参考资料，包含

a属于本项目标其它已发表文件；

b本文件中各处引用到文件资料，包含所要用到软件开发标准。

列出这些文件标题、文件编号、发表日期和出版单位，说明能够取得这些文件起源。

参考文件

备注

《XXXX项目需求规格说明书》

《XXXX项目系统概要设计汇报》

角色和职责

角色

职责

项目经理

指导和审查数据库具体设计

系统分析员

负责数据库具体设计

设计约定

说明系统设计需要遵照部分约定和约束等。

实现架构及功效逻辑

功效逻辑描述

提议分层描述本系统功效模块，功效模块可包含面向用户需求功效模块，也可包含面向实现功效模块（如实现数据库通用访问等），层次提议两到三层。

功效逻辑提议采取功效逻辑图＋文字说明方法描述，功效逻辑图提议采取Visio组织机构图来画，功效模块描述提议采取分级标题，便于组织和检索。

样例：该例子分三个层次画出了三层功效模块，依据项目标实际情况，几层功效模块图能够画在一张上图上。

4.1.1功效模块结构图

样例

4.1.1.1顶层功效模块图

4.1.1.2二层功效模块图

…

4.1.1.3三层功效模块图

…

4.1.2功效模块描述

样例

4.1.2.1组织定义

具体描述…

4.1.2.1.1单位名称维护

具体描述…

4.1.2.1.2部门定义

具体描述…

4.1.2.2步骤定义

具体描述…

软件体系架构

该章节关键描述系统实现体系架构，以期使读者从总体上了解项目标设计框架。软件体系架构描述包含在物理上，对象之间经过函数或过程调用相互作用；在逻辑上，对象之间经过集成、复合等方法实现设计复用。该章节更多内容面向编码和实现，对于不一样项目或采取不一样工具，设计文档使用图示或工具可能不一样，如面向对象设计能够用高层次类图、组件图、包图等和相关文字说明等描述整体体系架构，面向过程设计可能使用高层次函数功效分解来描述，另外该章节内容也包含对源代码组成高层次描述

软件体系架构描述中，另外很关键是描述系统采取通用或关键模块、组件设计思绪及实现框架（如对数据库访问通用实现）。这些通用设计在此处和在后续设计文档集中描述，有利用读者了解和阅读，也有利于设计文档维护。

面向编码和实现，描述怎样组织代码实现相关业务逻辑。对于不一样