详细设计说明书模板
详细设计说明书模板
标准文件修改页文件编号修改条款 修改内容修改人/日期生效日期全文首次发行分发部门会签详细设计说明书模板文件编号版木 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 编写目的 (3)1.2 背景 (3)1.3 名词定义 (3)1.3.1 公用名词 (3)1.3.2 专有名词 (3)2 总体设计 (3)2.1 需求设计 (3)2.1.1 主界面 (3)2.1.2 功能描述 (3)2.1.4 控制规则 (4)2.6 基本设计概念和处理流程（协同流） (4)2.7 结构（页面流） (4)2.8 业务流程 (4)3 接口设计 (4)3.1 档案外部接口 (4)3.2 档案内部接口 (4)3.2.1 功能窗口调用 (4)3.2.2 数据调用 (4)4 运行设计 (5)4.1 运行控制 (5)4.2 运行时间 (5)5 主要业务逻辑设计（逻辑流） (5)5.1 逻辑结构设计要点 (5)5.2 数据结构与程序的关系 (7)6 系统出错处理设计 (7)6.1 出错信息 (7)6.2 补救措施 (8)6.3 系统维护设计 (8)测试设计说明书1 引言1.1 编写目的1) 方便设计人员了解软件的具体功能；2) 规范开发过程，实现有据可查；3) 实现需求。
1.2 背景1.3 名词定义1.3.1 公用名词参见文档《名词定义》1.3.2 专有名词2 总体设计2.1 需求设计2.1.1主界面2.1.2 功能描述2.1.3 业务规则2.1.4 控制规则2.6 基本设计概念和处理流程（协同流）说明本系统的基本设计概念和处理流程，使用图表的形式。
2.7 结构（页面流）用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系.2.8 业务流程说明本系统功能处理流程，使用图表的形式。
3 接口设计3.1 档案外部接口3.2 档案内部接口3.2.1 功能窗口调用无3.2.2 数据调用可以在报表中被查询。
4运行设计4.1运行控制4.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 设计约束【内容】从《产品需求规格说明书》中提取需求约束。
例如：●系统应当遵循的标准或规范●客户实际的软件、硬件环境条件的约束●接口/协议的约束●软件质量的约束：稳定性、可靠性、性能等。
【裁剪原则】此部分内容不允许裁剪。
软件研发-详细设计说明书模板
附件6[XXX项目]详细设计说明书●文档属性是否●文档版本记录目录目录 (I)一、参考文档 (1)(一)相关项目文档 (1)(二)参考资料 (1)二、数据库详细设计 (1)三、接口详细设计 (3)四、公用模块（部件）详细设计 (3)五、特殊算法详细设计 (4)蓝色｛｝和红色｛｝内的内容为填写说明，请自行删除；本模板仅供参考，除必填项外，可根据项目实际情况调整。
一、参考文档(一)相关项目文档本项目交付物中其它相关文档。
例如：需求规格说明书、源程序清单、用户使用手册(二)参考资料｛以如下格式提供本文档撰写过程中所参考的所有文档。
例如：科技项目相关管理办法、行内制度等。
｝二、数据库详细设计（可单列成独立的文档）(一)表结构{表名（表功能说明）；字段名，字段数据类型，字段宽度，精度，非空标志，缺省值，字段中文备注；主键；外键}1.CD_CARD_ARCH 卡档案表{示例表}索引: ind_cd_card_arch1(substr(“card_no”,1,length(“card_no”)-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 关键词：能够体现文档描述容主要方面的词汇。
软件详细设计说明书模板V1
详细设计说明书模板目录1.系统概述[可选] (1)2.软件结构 (1)2.1.软件结构图 (1)2.2.对象关系模式图[适用于面向对象编程][可选] (1)2.3.模块清单 (1)3.模块详细设计 (2)3.1.模块名称1（标识符） (2)3.1.1.模块描述 (2)3.1.2.功能 (2)3.1.3.性能[可选] (2)3.1.4.输入/输出 (2)3.1.5.模块调用关系 (3)3.1.6.模块与需求对应关系 (3)3.1.7.角色与模块对应关系 (3)3.1.8.模块对表的操作关系 (4)3.1.9.流程逻辑[可选] (4)3.1.10.数据结构[可选] (4)3.1.11.算法[可选] (4)3.1.12.接口[可选] (4)3.1.13.用户界面设计[可选] (5)3.1.14.限制条件[可选] (6)3.1.15.尚未解决的问题[可选] (6)3.1.16.子模块设计[可选] (6)3.2.模块名称2（标识符） (6)3.3 (6)4.数据库详细设计 (6)4.1.E-R图 (6)4.2.T ABLE清单 (7)4.3.T ABLE设计说明 (7)1. 系统概述[可选]2. 概述项目背景和内容, 包括:3. 项目的委托单位、开发单位、主管部门、与其它项目的关系, 与其他机构的关系, 预期用户等。
4. 软件结构4.1. 软件结构图4.2. 功能模块结构图, 主要表示模块间的调用关系 4.3. 对象关系模式图[适用于面向对象编程] [可选]用图示的方式说明系统中各种公用类型的结构、类、接口、枚举的定义, 描述类、接口的关系。
SetGraphSubSystem(ByRef pEditor As IEditor, ByValczGraphSystemCode As String, Optional ByRef bSubGraphSysEnabledAs Boolean = False) As BooleanGetConnection(ByRef pApp As IApplication, ByVal czBeauCode AsString) As ADODB.Connection4.4.模块清单5.模块详细设计5.1.从本章开始, 逐个地给出各个层次中的每个模块的设计考虑。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
精品整理
页脚内容文档编号：____________ 保密级别：____________
XXX详细设计说明书
所属项目：
文件类别：
版本号：
编写者：
审核者：
批准者：
修订记录
目录
1引言 (3)
1.1编写目的 (3)
3 1.3参考资料 (3)
1.43
2 (4)
2.14
2.24
2.34 2.44
2.5 (4)
3 (4)
3.14
3.25
4总体方案确认 (5)
4.1系统总体结构确认 (5)
4.2系统详细界面划分 (5)
4.2.1应用系统与支撑系统的详细界面划分 (5)
4.2.2系统内部详细界面划分 (5)
5 (6)
5.1 (6)
5.2 (6)
5.36
5.3.17
5.3.27
5.3.37
6 (7)
6.17
6.27
6.37
6.3.17
6.3.27
6.3.38
6.3.48
6.3.58
6.3.68
7 (8)
7.18
7.28 1引言
1.1编写目的
说明编写详细设计方案的主要目的。
说明书编制的目的是说明一个软件系统各个层次中的每个程序（每个模块或子程序）和数据库
系统的设计考虑，为程序员编码提供依据。
如果一个软件系统比较简单，层次很少，本文件可以不单独编写，和概要设计说明书中不重复
部分合并编写。
方案重点是模块的执行流程和数据库系统详细设计的描述。
1.2背景
应包含以下几个方面的内容：
A. 待开发软件系统名称；
B. 该系统基本概念，如该系统的类型、从属地位等；
C. 开发项目组名称。
1.3参考资料
列出详细设计报告引用的文献或资料，资料的作者、标题、出版单位和出版日期等信息，必
要时说明如何得到这些资料。
1.4术语定义及说明
列出本文档中用到的可能会引起混淆的专门术语、定义和缩写词的原文。
2设计概述
2.1任务和目标
说明详细设计的任务及详细设计所要达到的目标。
2.2需求概述
对所开发软件的概要描述, 包括主要的业务需求、输入、输出、主要功能、性能等，尤其
需要描述系统性能需求。
2.3运行环境概述
对本系统所依赖于运行的硬件，包括操作系统、数据库系统、中间件、接口软件、可能的性
能监控与分析等软件环境的描述，及配置要求。
2.4条件与限制
详细描述系统所受的内部和外部条件的约束和限制说明。
包括业务和技术方面的条件与限制以及进度、管理等方面的限制。
2.5详细设计方法和工具
简要说明详细设计所采用的方法和使用的工具。
如HIPO图方法、IDEF（I2DEF）方法、E－R 图，数据流程图、业务流程图、选用的CASE工具等，尽量采用标准规范和辅助工具。
3系统详细需求分析
主要对系统级的需求进行分析。
首先应对需求分析提出的企业需求进一步确认，并对由于情况
变化而带来的需求变化进行较为详细的分析。
3.1详细需求分析
包括：
∙详细功能需求分析
∙详细性能需求分析
∙详细资源需求分析
∙详细系统运行环境及限制条件分析
3.2详细系统运行环境及限制条件分析接口需求分析
包括：
∙系统接口需求分析
∙现有硬、软件资源接口需求分析
∙引进硬、软件资源接口需求分析
4总体方案确认
着重解决系统总体结构确认及界面划分问题。
4.1系统总体结构确认
对系统组成、逻辑结构及层次进行确认，对应用系统、支撑系统及各自实现的功能进行确认，细化集成设计及系统工作流程，特别要注意因软件的引进造成的系统本身结构和公司其他系统的结
构变化。
包括：
•系统组成、逻辑结构及层次确认
•应用系统结构确认
•支撑系统结构确认
•系统集成确认
•系统工作流程确认
4.2系统详细界面划分
4.2.1应用系统与支撑系统的详细界面划分
应用系统与支撑系统之间的界面包括系统主服务器与其他服务器的服务范围及访问方式，网络及数据库对应用系统的支撑方式，全局数据的管理与存取方式等。
4.2.2系统内部详细界面划分
系统各功能之间的界面包括覆盖范围，模块间功能调用涉及到的系统模块及方法，全局数据
格式，系统性能要求等。
5系统详细设计
5.1系统结构设计及子系统划分
对系统的组成及逻辑结构进行设计前确认。
划分系统功能模块或子系统（如果有或者有必要，特别是大型的软件系统）。
5.2系统功能模块详细设计
按结构化设计方法，在系统功能逐层分解的基础上，对系统各功能模块或子系统进行设计。
此
为详细设计的主要部分之一。
用层次图描述系统的总体结构、功能分解及各个模块之间的相互调用关系和信息交互，用IPO 图或其他方法描述各模块完成的功能。
以上建议采用HIPO图进行功能分解与模块描述，更高的要
求建议采用IDEF0方法进行功能模型设计。
详细设计应用系统的各个构成模块完成的功能及其相互之间的关系，用IPO或结构图描述各模块的组成结构、算法、模块间的接口关系，以及需求、功能和模块三者之间的交叉参照关系。
每个模块的描述说明可参照以下格式：
模块编号：
模块名称：
输入：
处理：
算法描述：
输出：
其中处理和算法描述部分主要采用伪码或具体的程序语言完成。
对详细设计更高的要求建议用IDEF0图进行各功能模块的设计。
如果对软件需进行二次开发（包括功能扩展、功能改造、用户界面改造等），则相应的设计工
作应该设立子课题完成。
5.3系统界面详细设计
系统界面说明应用系统软件的各种接口。
整个系统的其他接口（如系统硬件接口、通讯接口等）
在相应的部分说明。
5.3.1外部界面设计
根据系统界面划分进行系统外部界面设计，对系统的所有外部接口（包括功能和数据接口）进行设计。
5.3.2内部界面设计
设计系统内部各功能模块间的调用关系和数据接口。
5.3.3用户界面设计
规定人机界面的内容、界面风格、调用方式等，包括所谓的表单设计、报表设计和用户需要的打印输出等设计。
此部分内容可能比较多。
6数据库系统设计
此数据库设计可单独成册，尤其对大型的数据库应用系统，即有一个单独的《数据库设计说明
书》。
6.1设计要求
6.2信息模型设计
确定系统信息的类型（实体或视图），确定系统信息实体的属性、关键字及实体之间的联系，详细描述数据库和结构设计，数据元素及属性定义，数据关系模式，数据约束和限制。
6.3数据库设计
6.3.1设计依据
说明数据被访问的频度和流量，最大数据存储量，数据增长量，存储时间等数据库设计依据。
6.3.2数据库种类及特点
说明系统内应用的数据库种类、各自的特点、数量及如何实现互联，数据如何传递。
6.3.3数据库逻辑结构
说明数据库概念模式向逻辑模式转换所采用的方法论及工具，完成数据库概念模式向逻辑模式的转换。
详细列出所使用的数据结构中每个数据项、记录和文件的标识、定义、长度及它们之间的相互关系。
此节内容为数据库设计的主要部分。
6.3.4物理结构设计
列出所使用的数据结构中每个数据项的存储要求、访问方法、存取单位和存取物理关系等。
建立系统程序员视图，包括：
•数据在内存中的安排，包括对索引区、缓冲区的设计；
•所使用的外存设备及外存空间的组织，包括索引区、数据块的组织与划分；
•访问数据的方式方法。
6.3.5数据库安全
说明数据的共享方式，如何保证数据的安全性及保密性。
6.3.6数据字典
编写详细的数据字典。
对数据库设计中涉及到的各种项目，如数据项、记录、系、文卷模式、子模式等一般要建立起数据字典，以说明它们的标识符、同义名及有关信息。
7信息编码设计
7.1代码结构设计
确认信息分类编码总体方案，进行分类代码结构设计。
7.2代码编制
按代码结构编制信息代码。