详细设计方案说明书模版
详细设计说明书模板
标准文件修改页文件编号修改条款 修改内容修改人/日期生效日期全文首次发行分发部门会签详细设计说明书模板文件编号版木 A0 贞数第1页共6贞編制部门 XX 部生效日期2019年10月15日编制审核批准□业务部 □研发部 □采购部 □生产部 □质量部 □行政部标准文件修订历史记录曽加•修订删除【模板使用必读：模板内容和页眉中【】包含内容为指导性的待替换文字，请在使用中替换为具体内容, 或删除。
文件提交时不得再含有这些内容J详细设计说明书模板引言L2 L3 L4编写目的 ..... 背景 ......... 术语打缩写解释参考资料 .....模块命名规则程序系统的组织结构3. 13.2 3.3程序1 4. 1 4.2 4.3 4.4 4.5 4.6 4.7 4.8 4.94. 104. 114. 12子系统划分 ...................... 模块划分.........................程序与功能需求、系统模块间的关系（标识符）设计说明................ 程序描述 .....功能 .........性能 .........输人项 .......输出项 .......算法 .........流程逻辑 .....接口 .........存储分配 .....注释设讣 .....限制条件 .....尚未解决的问题程序2 （标识符）设计说明4 4 4 45 5 5 5 56 6 6 6 6 6 67 7 7 7 7引言编写目的【给出项U详细设il•说明书的编写U的，同时指明读者对象。
】背景【说明:a.待开发软件系统的名称: b•本项U的任务提出者、开发者、用户和运行该程序系统的计算中心。
】术语与缩写解释【列出本文件中用到的专门术语的定义和外文首字母缩写的原词组J参考资料【提示：可包括：＜1）本项11经核准的计划任务书、需求规格说明书、合同、项U设计概要说明书或上级机关的批文；（2）本文档所引用的资料、规范等，列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。
详细设计说明书模板
产品详细设计说明书主要内容第1章引言 (1)1.1 文档用途 (1)1.2 阅读对象 (1)1.3 名词术语 (1)1.4 参考资料 (1)第2章概述 (2)2.1 系统概述 (2)2.2 系统功能定义 (2)2.3 设计约束 (2)第3章总体结构说明 (3)3.1 子系统结构 (3)3.2 模块程序构件结构图 (4)第4章数据模型（DAT A MODEL）设计 (6)4.1 逻辑实体模型 (6)4.2 表结构（物理设计） (7)4.3 视图列表 (9)第5章功能实现说明 (10)5.1 业务处理类模块 (10)5.2 数据流类模块 (14)第6章界面实现说明 (18)6.1 模块1 (18)6.2 模块2 (18)第1章引言1.1 文档用途【内容】说明此文档的主要用途。
【裁剪原则】此部分内容不允许裁剪。
1.2 阅读对象【内容】此文档将适合哪些人员阅读。
如：●产品设计工程师●产品开发工程师●产品测试工程师●其他相关人员【裁剪原则】此部分内容不允许裁剪。
1.3 名词术语【内容】在该份文档中，为使阅读者对使用到的名词术语有一个概念性的理解，需要对一些名词进行解释。
【裁剪原则】如果没有特别生疏的术语，此部分内容允许裁剪掉。
1.4 参考资料【内容】列出该文档编写时的主要参考资料。
主要包括：规范、《客户需求规格说明书》、老产品设计文档、其他子系统的设计文档等。
【裁剪原则】如果没有参考其他资料，此部分内容允许裁剪掉。
第2章概述2.1 系统概述【内容】说明此子系统“是什么”。
【裁剪原则】此部分内容不允许裁剪。
2.2 系统功能定义【内容】说明此子系统实现的主要功能，可逐条说明。
【裁剪原则】此部分内容不允许裁剪。
2.3 设计约束【内容】从《产品需求规格说明书》中提取需求约束。
例如：●系统应当遵循的标准或规范●客户实际的软件、硬件环境条件的约束●接口/协议的约束●软件质量的约束：稳定性、可靠性、性能等。
【裁剪原则】此部分内容不允许裁剪。
软件详细设计说明书 例
软件详细设计说明书例软件详细设计说明书一、引言本文档旨在详细描述软件的设计方案和实现细节，提供给开发人员和其他相关人员作为参考和指导。
本软件详细设计说明书主要包括软件系统的总体架构、各个模块的设计细节和算法等内容。
二、总体架构设计1. 系统概述本软件是一个xxx系统，旨在实现xxx功能。
系统分为xxx模块、xxx模块和xxx模块三个主要模块。
其中，xxx模块负责xxx功能，xxx 模块负责xxx功能，xxx模块负责xxx功能。
2. 系统设计原则为了保证软件的高性能、可扩展性和易用性，我们在系统设计中遵循以下原则：（1）模块化设计：将系统拆分为多个独立的模块，每个模块之间职责清晰，便于开发和维护。
（2）封装性设计：将每个模块的内部细节进行封装，提供简洁的接口给其他模块使用，减少模块间的耦合。
（3）可配置性设计：通过配置文件或参数的方式，实现软件的可定制性，以满足不同用户的需求。
（4）高性能设计：通过算法优化和资源管理，提高软件的运行效率和响应速度。
三、模块设计1. xxx模块（1）模块介绍：该模块负责xxx功能，主要包括xxx、xxx和xxx功能。
（2）模块接口设计：- 函数1：用于实现xxx功能，输入参数为xxx，输出参数为xxx。
- 函数2：用于实现xxx功能，输入参数为xxx，输出参数为xxx。
2. xxx模块（1）模块介绍：该模块负责xxx功能，主要包括xxx、xxx和xxx功能。
（2）模块接口设计：- 函数1：用于实现xxx功能，输入参数为xxx，输出参数为xxx。
- 函数2：用于实现xxx功能，输入参数为xxx，输出参数为xxx。
3. xxx模块（1）模块介绍：该模块负责xxx功能，主要包括xxx、xxx和xxx功能。
（2）模块接口设计：- 函数1：用于实现xxx功能，输入参数为xxx，输出参数为xxx。
- 函数2：用于实现xxx功能，输入参数为xxx，输出参数为xxx。
四、数据库设计1. 数据库结构设计为了支持软件的正常运行，我们设计了以下数据库表：（1）表1：用于存储xxx信息，包括xxx字段、xxx字段和xxx字段。
详细设计说明书
详细设计说明书详细设计说明书一、引言详细设计说明书是在需求分析说明书的基础上，对系统进行具体设计和实现方案的描述。
本文将介绍我们设计的系统的详细设计方案，包括系统的整体架构、模块划分、各模块的功能描述、数据结构与算法设计等内容。
二、系统架构本系统采用三层架构，包括表现层、业务层和数据层。
1. 表现层：负责与用户进行交互，接收用户的输入和显示系统的输出。
用户可以通过图形界面或命令行界面与系统进行交互。
2. 业务层：负责处理用户的请求和业务逻辑。
在本系统中，业务层主要包括用户管理模块、商品管理模块、订单管理模块等。
3. 数据层：负责处理数据的读写操作。
本系统使用关系型数据库管理系统作为数据存储介质，通过SQL语言来进行数据的访问。
三、模块划分与功能描述根据系统的需求，我们将系统划分为以下几个模块，并对每个模块的功能进行详细描述。
1. 用户管理模块：负责用户的注册、登录、个人资料修改等功能。
用户可以通过注册账号来使用系统，并可以根据需要修改自己的个人资料。
2. 商品管理模块：负责商品的发布、编辑、删除等功能。
商家可以通过此模块管理自己的商品信息，包括商品的名称、价格、库存等。
3. 订单管理模块：负责订单的生成、查询、取消等功能。
用户可以通过此模块查看自己的订单信息，并可以取消未支付的订单。
4. 支付管理模块：负责订单支付的处理。
用户可以通过此模块选择支付方式，并完成支付操作。
5. 物流管理模块：负责订单的发货和物流跟踪。
商家可以通过此模块将已发货的订单状态更新为已完成，并提供物流跟踪功能给用户。
四、数据结构与算法设计1. 用户信息表：包括用户ID、用户名、密码、邮箱等字段。
2. 商品信息表：包括商品ID、商品名称、价格、库存等字段。
3. 订单信息表：包括订单ID、用户ID、商品ID、订单状态、支付状态等字段。
4. 支付记录表：包括订单ID、支付方式、支付时间等字段。
我们将采用哈希表、链表等数据结构来实现对数据的存储和查询，同时使用合适的算法来实现对数据的增删改查等操作，保证系统的高效运行。
软件项目详细设计说明书模板
软件项目详细设计说明书模板目录第一章编写目的 (4)1.1作用 (4)1.1.1 预期读者 (4)1.2背景 (4)1.2.1 系统名称及版本号 (4)1.2.2 使用者 (4)1.2.3 与其它系统的关系 (4)1.3术语和缩写 (4)1.4参考资料 (5)第二章总体架构 (5)2.1系统说明 (5)2.2运行环境 (5)2.3基本设计概念以及处理流程 (5)2.4总体功能结构图 (5)2.5子系统清单 (5)2.6可测试性、维护/升级设计 (5)2.7可配置设计 (5)2.8尚未解决的问题 (6)第三章系统功能模块 (6)3.1模块名称 (6)3.1.1模块功能描述 (6)3.1.2模块框架设计以及处理流程 (6)3.1.3子模块划分列表 (6)3.1.4子模块设计说明 (6)3.2模块名称 (6)3.2.1模块功能描述 (6)3.2.2模块框架设计以及处理流程 (6)3.2.3子模块划分列表 (6)3.2.4子模块设计说明 (7)第四章接口说明 (7)4.1用户接口 (7)4.2外部接口 (7)4.3内部接口 (7)第五章数据结构设计 (7)5.1数据库环境说明 (7)5.1.1应用环境 (7)5.1.2参数配置 (7)5.2数据库设计 (7)5.2.1逻辑设计 (8)5.2.2物理设计 (8)5.2.2.1数据表汇总 (8)5.2.2.2表结构设计 (8)5.2.3安全性设计 (8)5.2.4备份恢复设计 (9)5.3数据库管理维护 (9)5.3.1数据库安装配置 (9)5.3.2数据库日常维护 (9)第六章系统出错处理设计 (9)6.1出错信息 (9)6.2出错处理 (9)第一章编写目的1.1作用【说明】《软件概要设计说明书》是在《软件需求规格说明书》的基础上，通过我方与用户方反复沟通形成的。
它必须充分反映《软件需求规格说明书》中的用户需求，如有改动必须征得用户的认可。
它将作为项目验收时重要的的标准和依据。
详细设计说明书模板
详细设计说明书模板一、引言。
详细设计说明书是软件开发过程中的重要文档，它描述了软件系统的详细设计方案，是软件开发人员在编码和测试阶段的重要参考依据。
本文档旨在为软件开发人员提供一个详细设计说明书的模板，以便他们能够按照统一的标准和格式编写详细设计说明书。
二、项目概述。
在本部分，应对项目的背景、目标、范围、功能和性能需求进行详细描述。
这部分内容应该包括对项目的整体理解，以及项目的基本需求和目标。
三、设计约束。
在本部分，应对项目的设计约束进行详细说明。
设计约束可能包括技术约束、硬件约束、软件约束、接口约束等内容。
这部分内容应该对设计过程中的各种约束进行全面、系统的描述。
四、系统架构。
在本部分，应对系统的整体架构进行详细描述。
系统架构包括系统的组成部分、模块划分、模块之间的关系等内容。
这部分内容应该对系统的整体结构进行清晰、完整的描述。
五、模块设计。
在本部分，应对系统的各个模块进行详细设计。
模块设计包括模块的功能、接口、数据结构、算法等内容。
这部分内容应该对系统的各个模块进行全面、细致的设计。
六、数据设计。
在本部分，应对系统的数据结构进行详细设计。
数据设计包括数据的组织结构、存储方式、访问方式等内容。
这部分内容应该对系统的数据进行全面、合理的设计。
七、界面设计。
在本部分，应对系统的用户界面进行详细设计。
界面设计包括界面的布局、样式、交互方式等内容。
这部分内容应该对系统的用户界面进行美观、易用的设计。
八、安全设计。
在本部分，应对系统的安全性进行详细设计。
安全设计包括系统的安全需求、安全策略、安全机制等内容。
这部分内容应该对系统的安全性进行全面、可靠的设计。
九、性能设计。
在本部分，应对系统的性能进行详细设计。
性能设计包括系统的性能需求、性能测试、性能优化等内容。
这部分内容应该对系统的性能进行全面、有效的设计。
十、测试设计。
在本部分，应对系统的测试进行详细设计。
测试设计包括测试计划、测试用例、测试环境等内容。
系统详细设计说明书(模板)
XXXXXXXXXXXXXXXXXXX项目名称详细设计说明书XXX公司二〇X X年X月文档修改记录版本号示例：、、、、……目录第一章引言 (4)目的 (4)背景 (4)术语定义 (4)参考资料 (4)第二章系统概述 (6)第三章程序1设计说明 (7)程序描述 (7)模块架构图 (7)功能 (7)类图 (7)增加功能（功能点） (8)程序流程 (9)测试和限制条件 (9)备注 (9)第四章程序2设计说明 (10)第五章公用接口程序说明 (11)全局变量 (11)公用界面或接口 (11)公用方法和过程 (11)第六章附件 (12)详细设计评审意见 (13)第一章引言1.1目的提示：简要说明编写这份详细设计说明书的目的，指出预期的读者。
本详细设计说明书的适用读者为：软件开发者、测试人员1.2背景1.3术语定义1.4参考资料提示：列出所本文档所使用的参考资料，包括：A 本软件开发所经核准的合同或标书或可行性报告等文档B 软件开发计划书C 需求分析报告D 测试方案（若存在初稿的话）E 概要设计说明书F 与本项目有关的已发表的文件或资料G 本文件中各处引用的文件、资料，所采用的软件开发标准和规范注意：必须列出文件、资料的作者、标题、编号、发表日期和出版单位，以说明这些文件资料的来源。
若某些文档有保密要求的，则要说明其保密级别。
第二章 系统概述画出系统的体系结构图，以说明系统体系结构的实现技术，所用到的数据库主体的描述、如何实现访问数据库、如何划分程序的主体部分。
可以采用MVC 模式表述、也可以采用UML 中的系统设计主要是基于MVC 设计模式，M 代表模型Model ，V 代表视图 View ， C 代表控制器Controller 。
MVC 模式将系统分为三层，层与层之间通过又一定的模式联系，使数据实体与业务逻辑、业务逻辑与页面展现分离。
MVC 模式图举例如下图：图2-1 MVC 模式图第三章程序1设计说明提示：从本章开始，逐步将各模块的功能和设计思想、内容等进行逐层解剖分析3.1程序描述提示：给出对该程序的简要描述，主要说明安排设计本程序的目的意义，并且，还要说明本程序的特点。
详细设计说明书(LLD模板)
XX Low Level Design SpecificationXX 详细设计说明书Prepared by拟制Date日期yyyy-mm-ddReviewed by 评审人Date日期yyyy-mm-ddApproved by批准Date日期yyyy-mm-ddAuthorized by签发Date日期yyyy-mm-ddKonka Research Institute康佳研究院All rights reserved所有侵权必究Revision record 修订记录Date 日期Revisionversion修订版本Description描述Author作者2001-06-08 1.00 initial 初稿完成name 作者名yyyy-mm-dd 1.01 revised xxx 修改XXX name 作者名yyyy-mm-dd 1.02 revised xxx 修改XXX name 作者名……………………yyyy-mm-dd 2.00 revised xxx 修改XXX name 作者名Distribution LIST 分发记录Copy No. Holder's Name & Role持有者和角色Issue Date分发日期1 <PDT R&D Representative> yyyy-mm-dd2 <Project Manager> yyyy-mm-dd3 <Team members> yyyy-mm-dd4 <Customer Representative> yyyy-mm-dd5 <Others> yyyy-mm-ddCatalog 目录1 I ntroduction 简介 (6)1.1 P urpose 目的 (6)1.2 S cope 围 (6)2 D etailed Design 详细设计 (6)2.1 M odule 1 Detail Design 模块1详细设计 (6)2.1.1 Data Description 数据描述 (6)2.1.1.1 Simple Data Description 简单数据描述； (6)2.1.1.2 Structure 1 or Class 1 结构1或类1 (7)2.1.1.3 Structure 2 or Class 2 结构2或类2 (7)2.1.2 Function Description 函数描述 (8)2.1.2.1 Function 1 函数1 (8)2.1.2.2 Function 2 函数2 (9)Table of contents for the table表目录Table 1 XX 表1 XX 6 Table of contents for the figure图目录Figure 1 XX 图 1 XX 7XX Low Level Design SpecificationXX 详细设计说明书Keywords 关键词：能够体现文档描述容主要方面的词汇。
项目开发详细设计方案说明书(超好用模板)完整版
<XX系统> 详细设计说明书XX有限公司修订记录目录第一章概述 (5)1.1.应用模块的目的 (5)1.2.应用模块总体描述 (5)1.3.应用模块接口描述 (5)1.4.假设条件 (5)第二章设计模式（Design pattern） (6)第三章类设计 (7)3.1.分块类图 (8)3.1.1.<类图1> (8)3.1.2.<类图n> (8)3.2.整体继承关系 (8)3.3.类描述 (9)3.3.1.<类名1> Class Description (9)3.3.2.<类名n> Class Description (10)第四章交互图 (12)4.1.<情景编号1: 情景名称> (12)4.1.1.交互图 (12)4.1.2.例外情况及条件 (13)4.2.<情景编号n: 情景名称> (13)第五章状态图 (14)5.1.<状态图编号1:状态图名称> (14)5.2.<状态图编号n:状态图名称> (15)第六章时序流程图 (16)第七章用户界面设计说明 (18)7.1.用户界面关系 (18)7.2.用户界面具体描述 (18)7.2.1.<界面编号1:界面名称〉 (18)7.2.2.<界面编号N:界面名称〉 (19)第八章测试考虑 (20)第九章附录 (21)9.1.附录A 代码举例 (21)9.2.附录B 设计问题 (21)9.2.1.<设计问题1> (21)9.2.2.<设计问题n> (21)第一章概述1.1.应用模块的目的请明确客户建立应用模块的目的。
1.2.应用模块总体描述描述应用模块的总体功能。
1.3.应用模块接口描述简要描述本应用模块的公共接口，具体接口会在相应的类中进行具体描述。
建议采用列表的方式。
1.4.假设条件列出在问题领域，项目方案及其它影响系统设计的可能方面内，应当成立的假设条件。
详细设计说明书模板
<项目名称> 详细设计说明书目录1前言 (1)1.1目的 (1)1.2适用范围 (1)1.3读者对象 (1)2模块汇总 (1)3模块详细设计 (1)3.1接口与属性设计 (1)3.1.1外部接口n实现设计 (1)3.2数据结构与算法设计 (2)4功能模块实现设计 (2)4.1公用模块实现设计 (2)4.2专用模块实现设计 (3)4.3存储过程实现设计 (4)4.4触发器实现设计 (4)5其他实现设计 (5)6程序文件清单 (5)7附录 (5)7.1引用文档/参考资料 (5)7.2术语表 (5)1前言【逐项描述每个软件模块的详细设计内容。
如果设计的部分或全部依赖于系统状态或方式，则应指出这种依赖性。
如果该设计信息在多条中出现，则可只描述一次，而在其他条引用。
应给出或引用为理解这些设计所需的设计约定。
系统的接口特性可在此处描述，也可在《接口设计书》中描述。
数据库设计或用于操作/访问数据库的设计，可在此处描述，也可在《数据库结构设计》中描述。
用户界面相关的设计，可在此处描述，也可在《用户界面设计》中描述。
】1.1目的【描述编写此文档的目的与目标。
】1.2适用范围【描述此文档的适用范围。
】1.3读者对象【描述此文档的预期读者。
】2模块汇总【简单描述系统的各个模块。
】3模块详细设计3.1接口与属性设计【系统的接口特性可在此处描述，也可在《接口设计书》中描述。
】3.1.1外部接口n实现设计【描述每个模块的主要接口与属性。
如果采用面向对象方法，相当于设计类的函数和成员变量。
】(1)接口中文名称：(2)接口英文名称：(3)接口内容与功能：详细描述接口的内容与功能，如实现数据传输或数据交换。
(4)接口硬件设施：详细描述接口的硬件设施，如交换机、传感器或输出设备。
(5)接口软件或中间件：详细描述接口软件或中间件的名称、功能、使用方法、生产厂商。
(6)接口的数据结构：详细描述接口的数据结构，如文件结构、数据库表结构。
详细设计说明书
详细设计说明书一、引言本详细设计说明书旨在对所设计的项目进行详细的阐述和说明。
本项目旨在实现某个特定的目标，并提供相应的解决方案。
二、项目背景项目背景介绍了项目的起源、目的和需求。
在这一部分，我们将详细解释项目的背景，为读者提供项目的背景信息。
三、系统概述系统概述部分提供了对待设计系统的整体概述。
这将包括系统的主要功能、所需技术和主要用途等方面的介绍。
四、系统架构系统架构提供了系统的整体结构和组成部分。
这一部分将详细描述系统的组成和各个组件之间的关系。
五、功能模块功能模块部分将详细介绍系统的各个功能模块以及它们之间的交互方式。
每个功能模块将包括输入、输出、处理逻辑和相关的数据处理等信息。
六、数据库设计数据库设计部分将详细介绍系统中所使用的数据库的结构和关系。
这将包括各个数据表的字段、主键和外键等信息。
七、界面设计界面设计部分将详细介绍系统各个界面的布局和设计风格。
这将包括界面的外观、交互方式和用户操作流程等方面的说明。
八、算法设计算法设计部分将详细介绍系统中涉及到的特定算法的设计原理和实现细节。
这将包括算法的输入、输出和核心逻辑等信息。
九、安全性设计安全性设计部分将对系统的安全性进行详细的论述。
这将包括对系统安全性的需求、威胁分析和相应的安全策略等方面的说明。
十、性能设计性能设计部分将详细介绍系统的性能需求和设计策略。
这将包括系统的响应时间、吞吐量和并发性等方面的说明。
十一、测试策略测试策略部分将详细介绍系统的测试计划和策略。
这将包括测试的目标、方法和相应的测试用例等方面的说明。
十二、部署方案部署方案部分将详细介绍系统的部署计划和流程。
这将包括部署的目标环境、步骤和所需资源等方面的说明。
十三、维护计划维护计划部分将详细介绍系统的维护策略和计划。
这将包括系统的更新、维护和支持等方面的说明。
十四、总结总结部分对整个详细设计进行总结，并提供对未来发展的展望。
这将包括项目的亮点、问题和解决方案等方面的总结。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
密级：机密文档编号：XXX_TS_TEMP_XXSJSMS版本号：V2.0【项目名称】详细设计说明书模板编写人：XXX批准人：XXX生效日期：2017年1月6日版权信息本文件涉及之信息，属XXX所有。
未经XXX允许，文件中的任何部分都不能以任何形式向第三方散发。
文档修订记录版本号修订日期修订人修订说明修订状态审核日期审核人批准人V0.12016-12-1XXX创建A2016-12-1XXX XXX V1.02016-12-28XXX调整需求分析方法M2016-12-29XXX XXX V2.02017-1-4XXX更换使用模板M2017-1-6XXX XXX修订状态：A--增加，M--修改，D--删除日期格式：YYYY-MM-DD目录1 概述 (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)1概述1.1编写目的<此处填写本文档的目的><例如：XXX项目的目的是：根据《XXX需求规格说明书》进行详细设计>1.2适用范围<此处填写本文档的适用范围等>1.3术语和缩写<此处填写本文档中所特有的术语和缩写，常用的术语和缩写统一编写在一个规范文档中>术语和缩写解释备注1.4参考资料指出为完成本文档所需要的参考资料，包括a属于本项目的其它已发表的文件；b本文件中各处引用到的文件资料，包括所要用到的软件开发标准。
列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。
>参考文件备注《XXXX项目需求规格说明书》《XXXX项目系统概要设计报告》2角色和职责角色职责项目经理●指导和审查数据库的详细设计系统分析员●负责数据库的详细设计3设计约定<说明系统设计需要遵循的一些约定和约束等。
>4实现架构及功能逻辑4.1功能逻辑描述<建议分层描述本系统功能模块，功能模块可包含面向用户需求的功能模块，也可包含面向实现的功能模块（如实现数据库的通用访问等），层次建议两到三层。
功能逻辑建议采用功能逻辑图＋文字说明方式描述，功能逻辑图建议采用Visio组织机构图来画，功能模块描述建议采用分级标题，便于组织和检索。
><样例：该例子分三个层次画出了三层功能模块，根据项目的实际情况，几层功能模块图可以画在一张上图上。
>4.1.1功能模块结构图<样例4.1.1.1顶层功能模块图IdealFlow工作流系统流程定义管理及监控组织定义工作流引擎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流程定义具体描述…>4.2软件体系架构<该章节主要描述系统的实现的体系架构，以期使读者从总体上了解项目的设计框架。
软件体系架构描述包括在物理上，对象之间通过函数或者过程调用相互作用；在逻辑上，对象之间通过集成、复合等方式实现设计的复用。
该章节更多的内容面向编码和实现，对于不同的项目或采用不同的工具，设计文档使用的图示或工具可能不同，如面向对象的设计可以用高层次的类图、组件图、包图等和相关文字说明等描述整体的体系架构，面向过程的设计可能使用高层次的函数功能分解来描述，另外该章节内容也包括对源代码组成的高层次描述><软件体系架构描述中，另外很重要的是描述系统采用通用或核心的模块、组件的设计思路及实现框架（如对数据库访问的通用实现）。
这些通用设计在此处以及在后续设计文档的集中描述，有利用读者的理解和阅读，也有利于设计文档的维护。
><面向编码和实现，描述如何组织代码实现相关业务逻辑。
对于不同的项目或采用不同的工具，设计文档使用的图示或工具可能不同，如面向对象的设计可以用高层次的类图、组件图、包图等和相关文字说明等描述整体的体系架构，面向过程的设计可能使用高层次的函数功能分解来描述，另外该章节内容也包括对源代码组成的高层次描述，建议的章节结构包括>4.2.1设计思路<描述系统总体设计采用的框架、工具、方法等，平台级的设计思路，以及对一些难点和复杂逻辑、权限等的处理思路><对于通常的项目，设计思路可能包括多个部分，可以分子章节描述，如框架、权限、策略等等>4.2.2包图及描述<提示：直接通过数据库进行操作的统计报表类系统该部分可以不描述><主要创建类包图，通过层次结构，以在逻辑上组织设计，在使用包图及描述中，要能体现设计和功能逻辑间的关系><一些建议，把一个框架的所有类放置在相同的包中。
一般把相同继承层次的类放在相同的包中。
彼此间有聚合或组合关系的类通常放在相同的包中。
彼此合作频繁的类，信息能够通过UML顺序图和UML合作图反映出来的类，通常放在相同的包中。
> <对于通常的项目，包图可能有多个，可以分子章节描述><样例，类包图示意，缺少描述>4.2.3类图及描述<提示：直接通过数据库进行操作的统计报表类系统，Sieble套件类系统该部分可以不描述><主要创建类包图，通过层次结构，以在逻辑上组织设计，在使用类图及描述中，要能体现设计和功能逻辑间的关系。
><此章节类图描述系统实现的高层次主要类以及它们自己的关系（如继承、聚合等），并描述出这些类的主要作用，此章节对属性和方法不需要太细化。
><对于通常的项目，类图可能有多个，可以分子章节描述><样例，类图示意，缺少描述>4.2.4主要程序描述<主要适合面向过程类设计或项目中复杂的逻辑处理，通过图释和说明描述项目中主要的函数功能以及调用关系，对函数的细节不需要太细化。
><对于通常的项目，主要程序可能有多个，可以分子章节描述>4.2.5组件图及描述<组件图，目的和“主要程序描述”相同，可以根据实际情况选择使用><样例，组件图示意，非面向对象设计也可以有组件图，缺少描述>4.2.6源代码目录结构<以树型结构并结合描述描述出系统的较高层次的源代码目录结构，以便读者能很快理解项目程序结构的组织，目录层次的颗粒度应到覆盖到各需求功能模块、核心体系架构的实现（基本可以和上面的设计文档描述的层次相当。
><样例，仅供参考XXX项目源代码业务功能A 登记模块，并初始化业务功能A1业务功能B打印组件打印模块，实现打印的通用功能图片库>4.2.7权限设计<说明该系统在权限设计的总体考虑。
>…4.3总体界面设计<提示：后台接口类的项目该部分可以不写>4.3.1设计原则<该项目中界面设计的要求、限定等设计中要注意的原则>4.3.2设计思路<该界面实现的设计思路，如使用XML形成界面菜单，采用CSS提供多套样式风格等> 4.3.3界面风格<界面的风格，如配色、操作等方面的考虑>4.3.4界面层次图<较高层次的界面的层次图，如建议和功能逻辑的层次相当>4.3.5界面原型<界面草图或美工设计的界面原型，可有主界面级、视图级、表单级等>5详细设计<详细设计是将“实现架构及功能逻辑”章节中功能逻辑、体系架构的内容在实现上的细化，以在更深的层次上分解功能逻辑和实现逻辑，整体的章节结构随着功能的细化可以看作对“实现架构及功能逻辑”的迭代和细化，但子模块的顶级章节层次仍采用二级标题层次。
对于该章节采用的描述工具和方法，“实现架构及功能逻辑”使用的许多工具仍能适用，但该章节更面向具体的实现逻辑，根据不同的项目和使用的工具，可采用如流程图、顺序图、协作图等等来描述实现的细节。
><该章节的基本面向以编码为主的项目，对于许多集成类的项目，如Notes邮件配置、Tivoli单点登录实现，也建议按功能模块来划分，参考以下章节的内容，适当调整章节结构，根据情况增加一些相关的图示和描述，以表达清楚该功能的实现设计。
如Notes的Internet 邮件配置，需要描述邮件系统设计思路、拓扑框架及相关的配置文档；Tivoli的单点登录实现，需要描述每个相关系统采用哪种单点登录模式，应用系统和服务器相应的改变、相关的配置等等。
><对于章节的细分，根据需求分析设计的模式可以有不同的方式，如采用功能模块分解或主题域分解。
对于目前的多数项目，虽然可能采用面向对象的语言实现，但我们多数采用面向过程的功能分解，一般建议子章节的结构采用功能逻辑分解。
对于一些业务或实现上通用的功能及模块建议单独列出，集中描述。
><对于较大的项目，如采用不同模块采用不同技术路线开发或功能组织分为几个大类，可采用分文档描述，也可在一个文档中描述。
如果在一个文档中描述，大类的详细设计可采用一级标题，如5.公文管理详细设计、6.门户详细设计>5.1模块A5.1.1概要说明<本模块的功能简述，如有多级层次，建议分层描述相关子模块。
可采用图示或文字说明，建议以文字说明为主，功能描述可以分子章节><样例，简单➢向内核系统登记几个proc文件，以便于向内核空间中查询安全联盟和eoute 表，以及虚接口的状况；➢初始化SA数据库（tdb链）；➢初始化SPDB数据库（eroute表）；➢初始化pf_key（PF_KEY套接口）；><样例，子章节组织定义：具体描述…单位名称维护：具体描述…部门定义：具体描述…流程定义：具体描述…>5.2.2实现框架<以下的章节结构目的是从不同的维度和视图来描述设计，供参考。