【免费下载】 详细设计说明书(模板)
详细设计说明书(模板)
XXX项目详细设计说明书（V1.0）修改记录目录1 引言 (1)1.1编写目的 (1)1.2背景 (1)1.3定义 (1)1.4参考资料 (1)2 业务总体描述 (1)2.1软件功能描述 (1)3 模块一设计 (1)3.1时序图 (1)3.2功能描述 (2)3.3功能实现规则 (2)3.4算法 (2)3.5数据结构 (2)3.6用户界面 (2)4 模块二设计 (2)4.1时序图 (2)4.2功能描述 (3)4.3功能实现规则 (3)4.4算法 (3)4.5数据结构 (3)4.6用户界面 (3)5 非功能性设计 (3)1引言1.1编写目的说明编写这份详细设计说明书的目的，指出预期的读者。
1.2背景说明：a)需开发的软件系统的名称；b)列出此项目的任务提出者、开发者、用户以及将运行该软件的计算环境。
1.3定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
1.4参考资料列出有关的参考资料，如：a)本项目经核准的计划任务书或合同、上级机关的批文；b)属于本项目的其他已发表的文件；c)本文件中各处引用的文件、资料、包括所要用到的软件开发标准。
d)列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
2业务总体描述2.1软件功能描述描述被开发软件的功能，如有同等作用的文件（如已编写的《软件功能规格说明书》）则可直接在此引述该文件名及归档的部门即可。
3模块一设计3.1时序图简述各模块的功能。
列明不同角色之间的使用，需要说明权限分配；比如不同用户可以使用特定的菜单功能；应体现各个模块之间的关联关系，时序图，有业务关系的功能模块可3.2功能描述包括：a)说明本模块的输入/输出参数（命名标识）和调用方式b)说明与本模块相直接关联的数据结构（数据库、表文件）。
3.3功能实现规则说明对各模块的业务。
3.4算法详细说明本程序所选用的算法，具体的计算机公式和计算步骤。
3.5数据结构反映数据元素之间的逻辑关系的数据结构3.6用户界面界面设计，可使用visio中的Windows User Interface制作，但应预先由分析人员与编程人员共同确定统一风格。
详细设计说明书_模板
详细设计说明书（编号：LY/QPR-06A-6）1引言1.1目的说明编写的目的，指出预期的读者1.2 背景1待开发的系统名称2 任务提出者、开发者、用户1.3 定义本文件中用到的专门术语的定义和外文首字母组词的原词组并解释1.4 参考资料1 本项目经核准的计划任务书、合同、上级批文等2 属于本项目的其他已发表的文件3 本文件各处引用的文件、资料包括所需用到的软件开发标准等列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些资料的来源2 程序系统的结构用一系列图表列出本系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间的层次结构关系3 程序1（标识符）设计说明从本部分开始，逐个给出各个层次中每个程序的设计考虑。
程序描述给出对该程序的简要描述，主要说明安排设计本程序的目的意义。
并且，还要说明本程序的特点（如是否驻内存，是否子程序，是否可重入，有无覆盖要求，是顺序处理还是并发处理等）3.1 功能可采用IPO（Input, Process, Output）图的形式3.2 性能包括对精度、灵活性和时间特性的要求3.3 输入项给出对每个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式、数量和频度、输入媒体、输入数据的来源和安全保密条件的描述。
3.4 输出项给出对每个输出项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输出的形式、数量和频度、输出图形及符号说明、安全保密条件的描述。
3.5 算法包括计算公式和计算步骤3.6 流程逻辑用图表并辅以必要的说明来标识3.7 接口用图形说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序，说明参数赋值和调用方式，说明与本程序直接关联的数据结构（数据库，数据文卷）3.8 存储分配3.9 注释设计/编码规范（可所有程序公用一份文档）3.10 限制条件运行中受的限制条件3.11 测试计划包括测试的技术要求、输入数据、预期结果、进度安排、人员职责等（？）3.12 未解决的问题在本阶段尚未解决而设计者认为在系统完成之前应解决的问题4 程序2（标识符）设计说明。
详细设计说明文书书模版
密级：机密文档编号：XXX_TS_TEMP_XXSJSMS版本号：【项目名称】详细设计说明书模板版权信息本文件涉及之信息，属XXX所有。
未经XXX允许，文件中的任何部分都不能以任何形式向第三方散发。
文档修订记录日期格式：YYYY-MM-DD目录1 概述.................................................. 错误!未定义书签。
编写目的.......................................... 错误!未定义书签。
适用范围.......................................... 错误!未定义书签。
术语和缩写........................................ 错误!未定义书签。
参考资料.......................................... 错误!未定义书签。
2 角色和职责............................................ 错误!未定义书签。
3 设计约定.............................................. 错误!未定义书签。
4 实现架构及功能逻辑.................................... 错误!未定义书签。
功能逻辑描述...................................... 错误!未定义书签。
功能模块结构图........................................ 错误!未定义书签。
功能模块描述.......................................... 错误!未定义书签。
软件体系架构...................................... 错误!未定义书签。
详细设计说明书(仅用于学习的参考模板)
付高钢村医药管理系统项目详细设计说明书1引言1.1编写目的本说明书是医药管理系统的详细设计。
其编写目的是在概要设计的基础上，针对该项目的每个模块，每个功能的实现方法进行详细的设计和划分，按照详细设计说明书的要求，进一步明确系统结构，为项目开发人员后期的编码工作做准备。
本文档的预期的读者是：项目开发人员项目经理项目测试人员1.2背景在前一阶段的概要设计文档中，已经通过顺序图解决了该系统功能的实现流程，包括系统的各模块间的关系设计等。
本文档就是在前一阶段成果的基础上，继续对系统的各模块进行详细的划分和说明。
2概述本项目的任务提出者：见概要设计文档单位：见概要设计文档开发者：见概要设计文档用户：见概要设计文档实现该软件的计算中心或计算机网络：见概要设计文档2.1基线以需求分析和概要设计为基准。
2.2范围本概要设计文档提供给系统设计开发人员，包括详细设计人员和项目组成员。
2.3定义2.4参考资料2.5术语与缩写解释3模块命名规则驼峰标识，由单词的全拼组成，除首单词外每个单词的首字母大写，例如：medcineManager4模块汇总4.1模块汇总表提示：这里模块是指相对独立的软件设计单元，例如对象类、函数包等等。
5子系统模块设计5.1类别管理模块5.1.1功能描述用户登录进入类别管理页面，能进行药品类别的管理，主要包括类别的添加，修改，查看和统计。
5.1.2相关模块5.1.3类图5.1.4类别管理类5.1.4.1方法5.1.4.1.1方法—药品信息的添加:public String add()5.1.4.1.1.1功能对药品的类别信息进行添加，类别编码是类别对象的一个标示，当添加一个类别信息时，需要判断此类别是否已经在数据库中，如果存在，则提示已存在该类别。
5.1.4.1.1.2参数无5.1.4.1.1.3算法无5.1.4.1.2方法—类别信息的模糊查询:public String queryallcategory()5.1.4.1.2.1功能为了方便用户查询已有类别，类别信息管理模块提供了类别模糊查询。
详细设计说明书-模板
请输入文档名称目录1引言 (4)1.1 编写目的 (4)1.2 项目背景 (4)1.3 名词解释 (4)1.4 参考资料 (4)2软件结构概述 (6)2.1 系统逻辑结构示意图如下：........................................................................ 错误！未定义书签。
2.2 系统模块划分及其相互关系........................................................................ 错误！未定义书签。
3模块设计 ..................................................... 错误！未定义书签。
3.1 模块1（编号XXXXXX） ............................................................................ 错误！未定义书签。
3.1.1 功能 .............................................................................................. 错误！未定义书签。
3.1.2 性能 .............................................................................................. 错误！未定义书签。
3.1.3 输入项 .......................................................................................... 错误！未定义书签。
3.1.4 输出项 .......................................................................................... 错误！未定义书签。
详细设计说明书_模板
XX项目详细设计说明书0引言 (3)0.1文档目的 (3)0.2文档范围 (3)0.3读者对象 (3)0.4参考文献 (3)0.5术语与缩写解释 (3)2程序结构 (3)3类A详细设计说明 (3)3.1类描述 (3)3.2功能 (4)3.3性能 (4)3.4输人项 (4)3.5输出项 (4)3.6算法 (4)3.7流程逻辑 (4)3.8接口 (4)3.9存储分配 (5)3.10注释设计 (5)3.11限制条件 (5)3.12测试计划 (5)3.13尚未解决的问题 (5)类B详细设计说明 (6)详细设计说明书0引言0.1文档目的提示:说明编写这份详细设计说明书的目的，指出预期的读者。
0.2文档范围0.3读者对象0.4参考文献0.5术语与缩写解释2程序结构提示:用一系列图表列出本模块的名称、标识符和其他之间模块的层次结构关系。
3类A详细设计说明3.1类描述提示:给出对该类的简要描述，主要说明设计本类的目的意义，并且，还要说明本类的特点（如：是常驻内存还是非常驻？是否子程序？是可重人的还是不可重人的？有无覆盖要求？是顺序处理还是并发处理等）。
3.2功能提示:说明该类应具有的功能，可采用相关图示的形式。
3.3性能提示:说明对该类的全部性能要求，包括对精度、灵活性和时间特性的要求。
3.4输人项提示:给出对每一个输入项的特性，包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。
数量和频度、输入媒体、输入数据的来源和安全保密条件等等。
3.5输出项提示:给出对每一个输出项的特性，包括名称、标识、数据的类型和格式，数据值的有效范围，输出的形式、数量和频度，输出媒体、对输出图形及符号的说明、安全保密条件等等。
3.6算法提示:详细说明本类所选用的算法，具体的计算公式和计算步骤。
3.7流程逻辑提示:用图表（例如流程图、判定表等）辅以必要的说明来表示本类的逻辑流程。
3.8接口提示:说明本类的详细设计接口，辅以必要的图表。
详细设计说明书
详细设计说明书1. 引言本文档旨在提供一个详细的设计说明，以解释系统的结构、功能和设计决策，以及为开发人员提供指导。
2. 系统概述本系统是一个xxx系统，用于xxx。
系统的主要功能包括xxx、xxx和xxx。
本文档将详细描述系统的设计和实现。
3. 系统架构本系统采用xxx架构，包括以下模块：•模块1：xxx，负责xxx功能。
•模块2：xxx，负责xxx功能。
•模块3：xxx，负责xxx功能。
每个模块都有明确的责任和功能，并且通过定义的接口进行通信。
4. 模块设计4.1 模块1设计模块1主要负责xxx功能。
其设计包括以下几个部分：•子模块1：负责xxx功能的实现。
•子模块2：负责xxx功能的实现。
模块1和子模块之间采用xxx接口进行通信，确保各个模块之间的松耦合。
4.2 模块2设计模块2主要负责xxx功能。
其设计包括以下几个部分：•子模块1：负责xxx功能的实现。
•子模块2：负责xxx功能的实现。
模块2和子模块之间采用xxx接口进行通信，确保各个模块之间的松耦合。
4.3 模块3设计模块3主要负责xxx功能。
其设计包括以下几个部分：•子模块1：负责xxx功能的实现。
•子模块2：负责xxx功能的实现。
模块3和子模块之间采用xxx接口进行通信，确保各个模块之间的松耦合。
5. 数据库设计本系统使用xxx数据库，并设计了以下表：•表1：用于存储xxx的数据。
•表2：用于存储xxx的数据。
•表3：用于存储xxx的数据。
表之间通过xxx关系进行关联，以满足系统的功能需求。
6. 接口设计本系统提供了以下接口供外部系统或模块使用：•接口1：用于xxx功能的调用。
•接口2：用于xxx功能的调用。
•接口3：用于xxx功能的调用。
每个接口都有清晰的输入和输出定义，并遵循统一的接口规范。
7. 系统测试本系统将进行以下测试：•单元测试：对每个模块和子模块进行单元测试，确保其功能的正确性。
•集成测试：对各个模块之间的集成进行测试，确保模块之间的协作正常。
详细设计说明书模版
**有限公司{公司名＋项目名}详细设计说明书当前版本：发布日期：摘要简要描述该文档的内容。
修改历史目录1概述 (4)2结构图 (4)3数据结构 (4)4功能模块详细描述 (4)5需求以及设计跟踪表 (4)1概述本章描述详细设计将实现的内容，以及受影响的子系统。
假如用了软件图形工具，本章必须包含完整的软件图形模块目录的路径名。
2结构图软件系统功能模块的图形描述，它可以让读者对功能模块有一个全面的了解。
同时，它也提供了一个有用的索引及一个有意义的调试和维护指南。
数据必须显示在结构图中，同时，流程线应指明模块访问存储区的目的（读、写或修改）。
必须解释所有的用符号表示的内容（包括模块、参数和数据存储区等）。
3数据结构•如果某一数据类型由其它的数据类型组成，要保持信息上的一致性。
•如果使用一特殊结构，请指明使用原因或优于其它结构的方面。
•在选择一个有效的结构时，要考虑以下几个方面：-- 在目标上执行的操作类型-- 访问目标的类型和频度-- 结构的有效性4功能模块详细描述首先请简要介绍模块的目的。
可以用以下格式描述功能模块的详细设计：•模块名称•主要功能描述•模块的输入参数的名称、数据类型、顺序位置、格式等•模块的输出参数的名称、数据类型、顺序位置、格式，以及错误标记等•过程和功能调用•数据引用（全局，本地，结构）•模块的处理流程（采用流程图、判定表辅以必要的说明来表示逻辑流程）•模块的界面设计（可以采用图片和表格的形式，具体内容包括：界面格式；界面要素的位置、类型和特殊约定；操作及步骤等必要的说明）•接口（用图的形式说明本程序所隶属的上一层模块及隶属本模块的下一层模块，说明参数赋值和调用方式，说明与本程序直接关联的数据结构）•限制条件（说明本模块运行所受到的限制条件）•伪代码5需求以及设计跟踪表。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
<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.假设条件列出在问题领域，项目方案及其它影响系统设计的可能方面内，应当成立的假设条件。
包括系统的约束条件和应遵循的标准。
详细设计说明书第二章设计模式（Design pattern）请列出本模块设计时使用的设计模式，请参考“Design Patterns” By Erich Gramma, Helm, Johnson & Vlissides, gang of four ISBN 0-201-63361-z (中文《设计模式》-机械工业出版社)。
详细设计说明书第三章类设计类图(Class Diagram)描述类和类之间的静态关系。
与数据模型不同,它不仅显示了信息的结构,同时还描述了系统的行为。
在类图的基础上，利用状态图、关系图等进一步描述了系统其他方面的特性。
类图主要描述了：∙类（包括类的实例）∙属性（表示知识型责任或数据）∙方法（表示操作责任或功能）∙类之间的关联关系∙类之间的聚合关系∙在父类及子类之间的继承关系∙正式或非正式的约束描述（可选）本节针对每个构件的进行了详细描述，记录每个类的实例数，每个实例的占用数据库空间的平均大小等信息。
类图的设计在整个项目生命周期内通过迭代的方法得到。
方案的复杂程度决定迭代的次数。
∙在考虑初始(initial)或概念(conceptual)角度类图时，我们讨论系统作什麽，该阶段即传统意义上的分析阶段，通过理解业务模型的哪些业务模型应在软件系统中实现来定义问题和需求。
在这点上设计保持技术中立，但并不意味着丝毫不考虑技术，因为此时对于如何构造软件系统的决定不是首要的关注问题。
∙下一步，设计逻辑(logical)或具体(specification)角度类图时，开始关心系统如何实施和定义方案的整体结构。
诸如并行及分发，协作及共享，交易及存储，用户界面性能，及系统接口例如通讯接口。
在设计阶段，设计依赖于技术和架构，同时设计决策也会影响技术和架构。
详细设计说明书∙最后的迭代是设计物理或实施角度类图，基于所选的实施语言细化架构设计。
为了处理特定的实施细节，我们可能引入新的类或对现有的类进行重新定制。
请明确本节描述的是何种角度的类图。
类图的目的在于通过研究业务、用户及系统的需求，制定全面的软件模型。
创建完善的类图有助于完成如下工作:∙通过研究系统中包含的对象，优化并精简系统。
∙是系统应用架构某些层次设计的出发点，如用户界面、数据库建模。
∙通过分析问题所在及其相关领域，恰当建立对象模型，有助于明确分工，以支持并行开发。
∙通过使用简洁明了的表示方法，进一步确认系统设计。
∙全面考虑使用合适的应用设计模型、方法，避免不必要的重复工作。
∙遵循正确的设计原则，方法以提高设计质量。
在开发组合客户中更好的理解系统的设计有助于系统的重复利用和增量开发。
使用CASE工具生成图表。
3.1.分块类图本段按照模块的不同部分的分块描述类图。
对于小的模块不须分块。
3.1.1.<类图1>画一个类图仅描述与该部分相关的那些特征。
3.1.2.<类图n>对每个部分重复上面的段落要求。
3.2.整体继承关系下面的图表描述整个应用模块的类图，在此仅显示类名及类型的。
3.3.类描述本章描述上述章节中提到类的详细信息。
若有可能，使用CASE工具生成这些类描述。
类列表：请在类名出提供连接指向类的具体描述。
类名简要描述是否为接口类3.3.1.<类名1> Class Description注：Pub/Prv/Pro 代表private, protected, public 3.3.2.<类名n> Class Description详细设计说明书注：Pub/Prv/Pro 代表private, protected, public详细设计说明书第四章交互图交互图以图形方式描述了系统之间的交互关系。
初始的交互图仅显示分析阶段主要业务对象间主要的消息流动。
后续的交互图中包含更多的控制类，接口类，通讯，分布和存储等功能类。
初始行为仅描述使用案例或具体情景中所描述的功能，后续交互图中会描述更多系统内部的行为。
交互图是实例级的图，它描述了具体对象实例间消息的沟通及参数的传递，描述了系统动态交互。
交互图作为功能性需求说明和类图之间的桥梁，帮助确定对象行为，发现问题，协助设计决定，选择其他设计方法。
作为类图的补充。
交互图也可帮助评估类的设计是否能满足功能性需求，交互图和类图都是叠代开发的。
本文仅对复杂情况使用交互图描述。
请为不同的情景进行编号。
并在交互图列表的情景编号处提供联接。
交互图列表：情景编号情景名称情景描述相关使用案例4.1.<情景编号1: 情景名称>4.1.1.交互图描述主要的流程，建议使用Rational Rose 工具示例：4.1.2.例外情况及条件描述可能的例外情况及条件。
可选。
4.2.<情景编号n: 情景名称>对每个交互图重复上面的段落要求。
第五章状态图状态图描述了某一具体类的行为或生命周期。
它描述了其可能的状态表现，由外界刺激引起的状态变化。
状态图描述了某个类与其它类交互时复杂的状态变化。
以图形方式描述状态相关的行为能力，阐明了触发的事件，触发条件，及相应的行为。
本章描述了复杂的主要的状态转换。
请为不同的状态图进行编号。
并在状态图列表的编号处提供联接。
状态图列表：状态图编号名称描述相关类5.1.<状态图编号1:状态图名称>示例：建议使用Rational Rose 工具必要时可提供下表帮助描述。
状态子状态入口动作内部动作出口动作状态子状态事件条件变化新状态5.2.<状态图编号n:状态图名称>对每个交互图重复上面的段落要求。
第六章时序流程图通过时序图描述一个事件、功能的顺序处理过程。
图示方式表叔，并文字描述每步过程。
示例：第七章用户界面设计说明用户界面设计说明描述用户期待看到的屏幕序列（窗口，对话框，及提示）及其与其与系统的交互。
用户界面设计也包括详细的屏幕设计、对象、窗口小部件、选项、菜单、按键、视觉、对话框、按键状态、屏幕行为、用户意外处理及错误信息、及所有的外部用户帮助。
7.1.用户界面关系使用图显示用户界面的关系。
通过矩形表示每个界面。
确保窗口的类名能反映该窗口的业务并且与项目编码命名规则一致。
如果用户能从某窗口打开另一个窗口，请用带剪头的连线表示。
附上界面列表。
在编号处应提供超级连接到相应的页面描述。
7.2.用户界面具体描述本章描述系统中每个界面的详细设计。
必要时附上屏幕抓取得界面。
7.2.1.<界面编号1:界面名称〉∙内部组件关系典型地以OMT模型的方式，显示界面与界面内组件的关系。
∙域描述针对每个域进行具体描述，包括类型，长短，是否是必须录入的域。
详细设计说明书∙Tab 键顺序解释视图的Tab键顺序。
指出光标起始点位置。
∙行为描述每个具体行为的详细信息：∙帮助信息定义帮助面板及与视图相关的其它帮助信息细节。
∙意外事件处理及错误信息描述如何处理错误及对用户动作发生了何种响应。
7.2.2.<界面编号N:界面名称〉重复上面的段落及子段落的要求。
详细设计说明书第八章测试考虑针对模块测试和集成测试给出测试时应考虑的问题，包括前提条件。
详细设计说明书第九章附录9.1.附录A 代码举例针对主要的接口，给出使用举例，也可放在具体的类描述之后，建议使用伪代码。
9.2.附录B 设计问题本章描述用户界面设计过程中引发的问题。
9.2.1.<设计问题1>描述问题背景，问题本身，为解决问题应采取何种措施，阐述它当前的状态。
9.2.2.<设计问题n>重复上节内容。
日期：2019-9-11 页码：21。