详细设计说明书书真正例子
详细设计说明书示例
1．引言编写目的本说明书提供了freeswan各个模块部件的说明，以供编码人员具体实现及今后的维护工作。
2．总体设计设计原则在确定目标系统的过程中，主要遵循了以下几个原则：目标系统基本上完整地实现IPSec协议族，完全支持VPN的要求；目标系统的服务器端一定要建立在具有自主版权的内核操作系统之上；目标系统的客户端使用方便、界面友好、配置和管理简单灵活。
软件结构该软件由如下几个模块组成：KLIPS模块――实现对进入或外出IP包的安全处理，如：加密、认证等（运行在内核空间）Pluto模块――实现IKE协议，完成安全联盟的协商（运行在用户空间）PF_KEY模块――实现pfkey2协议，完成上述两个模块间关于SA的通信3．程序描述源代码文件组成本程序由两大模块组成，一部分是klips，它运行在操作系统内核空间，主要负责安全联盟和密钥的管理工作，以及对数据报的加密、解密的处理工作；一部分是pluto，它是一个运行在用户空间的守护进程，主要负责安全联盟的协商工作。
下面分别是它们的文件组成：源文件目录|―――freeswan|――klips|――libdes|――pluto|――utilsKLIPS（内核IPsec）详细设计－－―――klips ipsec的核心实现模块|――net|――ipsec|――登记模块，并初始化|――ipsec_tunnel. 数据包的处理并发送模块|――数据包接收并处理模块|――管理SA的模块|――sha1实现模块，由改编|――实现模块|――|――路由表的radix数的实现模块|――对上个文件的改编|――实现PF_KEY2协议的模块|――对上个文件的改编|――|――utils|――用户操作eroute表的模块|――用户操作SA库的模块|――同上|――用户操作虚接口的模块|――登记及初始化模块概要说明功能向内核系统登记几个proc文件，以便于向内核空间中查询安全联盟和eoute表，以及虚接口的状况；初始化SA数据库（tdb链）；初始化SPDB数据库（eroute表）；初始化pf_key（PF_KEY套接口）；模块所涉及的文件: int ipsec_init(void): int ipsec_tdbinit(void): int ipsec_radijinit(void): int pfkey_init(void)变量说明proc文件结构将下列结构登记到内核系统中，则内核就可以通过proc文件系统向应用程序提供一个安全的界面来存取如SA、eroute表等资料。
详细设计说明书(模板)
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制作，但应预先由分析人员与编程人员共同确定统一风格。
详细设计说明文书书模版
密级：机密文档编号：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功能为了方便用户查询已有类别，类别信息管理模块提供了类别模糊查询。
系统详细设计说明书[范例]
![系统详细设计说明书[范例]](https://img.taocdn.com/s3/m/1b667574a2161479171128bb.png)
XXXXXXX管理系统详细设计说明书Prepared by拟制李清清Date日期2012-10-18Reviewed by 评审人Date 日期Approved by批准Date 日期Revision Record 修订记录目录1引言 (1)1.1编写目的 (1)1.2背景 (1)1.3参考资料 (1)1.4术语定义及说明 (1)2设计概述 (1)2.1任务和目标 (1)2.1.1需求概述 (1)2.1.2运行环境概述 (1)2.1.3条件与限制 (1)2.1.4详细设计方法和工具 (2)3系统详细需求分析 (2)3.1详细需求分析 (2)3.2详细系统运行环境及限制条件分析接口需求分析 (2)4总体方案确认 (2)4.1系统总体结构确认 (2)4.2系统详细界面划分 (2)4.2.1应用系统与支撑系统的详细界面划分 (2)4.2.2系统内部详细界面划分 (3)5系统详细设计 (3)5.1系统结构设计及子系统划分 (3)5.2系统功能模块详细设计 (3)5.3系统界面详细设计 (3)5.3.1外部界面设计 (3)5.3.2内部界面设计 (4)5.3.3用户界面设计 (4)6、数据库系统设计 (4)6.1设计要求 (4)6.2 信息模型设计 (4)6.3 数据库设计 (4)6.3.1 设计依据 (4)6.3.2 数据库选型......................................... 错误！未定义书签。
6.3.3 数据库种类及特点 (4)6.3.4 数据库逻辑结构 (4)6.3.5 物理结构设计 (4)6.3.6 数据库安全 (4)6.3.7 数据字典 (5)7 信息编码设计 (5)7.3 代码结构设计 (5)7.4 代码编制 (5)1引言1.1编写目的说明编写详细设计方案的主要目的。
说明书编制的目的是说明一个软件系统各个层次中的每个程序（每个模块或子程序）和数据库系统的设计考虑，为程序员编码提供依据。
软件详细设计说明书实例
F o r p e s o n a u s e o n y s t u d y a n d r e s a r c h;n o t f r c o m me r c a u s e软件详细设计说明书实例2022年4月目录1 引言 (2)1.1 编写目的 (2)1.2 项目背景 (2)1.3 定义 (2)1.4 参考资料 (3)2 总体设计 (3)2.1 需求概述 (3)2.2 软件结构 (4)3 程序描述 (6)3.1 01登陆模块 (6)3.2 02管理模块............................................................................................ 错误!未定义书签。
3.3 031图书信息查询模块 .......................................................................... 错误!未定义书签。
3.4 032学生信息查询模块 .......................................................................... 错误!未定义书签。
3.5 021入库管理模块 .................................................................................. 错误!未定义书签。
3.6 022学生借书模块 .................................................................................. 错误!未定义书签。
3.7 023学生还书模块 .................................................................................. 错误!未定义书签。
详细设计说明书模板
详细设计说明书模板文档编号：未填写保密级别：未填写XXX详细设计说明书所属项目：未填写文件类别：未填写版本号：未填写编写者：未填写审核者：未填写批准者：未填写修订记录：日期。
修订版本。
修改章节。
修改描述。
作者。
目录引言本文档旨在详细说明XXX的设计方案，以便于开发人员按照规范进行开发。
本文档的读者应具备一定的软件开发知识和相关技术背景。
编写目的本文档的编写旨在为开发人员提供清晰的设计方案，以便于开发人员能够高效地进行开发工作。
同时，本文档也为后续的维护和升级提供了重要的参考依据。
背景XXX是一个重要的软件项目，其设计和开发周期较长，需要高度关注软件的可靠性和稳定性。
因此，本文档的编写至关重要，它将为整个项目的开发和维护提供指导和支持。
参考资料本文档的编写参考了多种相关的技术资料和文献，包括但不限于XXX技术规范、XXX开发手册、XXX编程规范等。
术语定义及说明本文档中所涉及的术语及其定义如下：XXX：指代具体的软件名称；XXX：指代具体的功能模块名称；ZZZ：指代具体的技术术语或概念。
内部界面设计在内部界面设计方面，我们需要考虑员工使用系统的体验和效率。
首先，我们需要设计一个简洁明了的主界面，让员工能够快速找到所需的功能。
其次，我们需要设计一个方便的导航菜单，让员工能够快速进入各个模块。
最后，我们需要考虑界面的美观性，使员工使用系统时感到舒适和愉悦。
用户界面设计在用户界面设计方面，我们需要考虑用户的使用惯和需求。
首先，我们需要设计一个易于操作的界面，让用户能够快速找到所需的功能。
其次，我们需要考虑用户的视觉体验，使界面看起来美观舒适。
最后，我们需要设计一个方便的导航菜单，让用户能够快速进入各个模块。
数据库系统设计在数据库系统设计方面，我们需要考虑数据的安全性和可靠性。
首先，我们需要设计一个合理的数据库结构，使数据能够被高效地存储和检索。
其次，我们需要考虑数据的备份和恢复，以防止数据丢失。
最后，我们需要设计一个权限管理系统，以保护数据的安全性。
详细设计说明书
详细设计说明书
设备管理系统
登录
权限管理
设备管理维修管理用户管理密码管理添加设备维护设备信息设备现值录入维修信息维护维修信息录入用户信息维护用户信息修改自身密码
开始
输入用户名和密码
调用权限认证系统
终止Y
N
用户是否合法
用户名或密码输入错误进入系统
开始
设备信息、设备状态信息
调用查询模块、新
设备数据录入
进入系统
响应操作消息和内筒
终止
开始
维修设备信息，数据调用设备基础信息模块
进入系统
响应操作消息
终止
开始
输入用户原密码、新密码以
及确认密码
终止
两次密码输入不一致判断新密码是否与确认密码一致
操作成功
开始
根据提示依次输入相应信息调用用户信息管理模块
进入相应界面
响应操作信息
终止。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
详细设计说明书1.引言1.1编写目的本详细设计说明书是针对网络信息体系结构的课程作业而编写。
目的是对该项目进行详细设计，在概要设计的基础上进一步明确系统结构，详细地介绍系统的各个模块，为进行后面的实现和测试作准备。
本详细设计说明书的预期读者为本项目小组的成员以及对该系统感兴趣，在以后想对系统进行扩展和维护的人员。
2. 系统的结构●ui：系统界面部分，负责接受用户输入，显示系统输出，负责其他模块功能的协调调用，并含有站内搜索功能，即在用户指定的已打开的ftp站点中搜索用户需要的资源。
ui 部分调用common部分的功能读取xml文件中保存的界面元素属性信息，用户最近访问过的10个ftp信息，用户选择的下载的ftp内容列表及其他需要通过xml文件保存的信息。
●client：实现ftp客户端的功能，ftp连接，ftp上传及下载：上传或下载用户指定的资源，并返回相应的信息。
●search:资源实时检索部分，根据用户输入的资源名称关键字，资源类型和选择的检索方式检索用户需要的资源，并验证资源的可用性，返回可用资源及其大小，速度等相关信息。
●preview：资源预览部分，显示用户选择的资源的部分内容，以使用户决定是否需要该资源。
preview部分调用common部分读取属性文件的内容亦显示预览资源内容的显示格式。
3．模块1（ui）设计说明3.1模块描述实现用户界面的包，含有11个文件51个类，是本系统中最复杂的代码。
3.2功能负责接受用户输入，显示系统输出，其他模块功能的协调调用，并含有站内搜索功能，即在用户指定的已打开的ftp站点中搜索用户需要的资源。
3.3交互的模块client，search，preview，common。
3.4 模块设计该模块中的主要文件，文件中包含的主要类及其功能和与其它包的交互如下：●MainFrame.java：MainFrame是含有主函数的类，也是lyra客户端开始执行的类，它先后进行资源的初始化，显示主界面等工作，根据屏幕大小设置界面大小，设置界面的观感。
●FtpFrame_AboutBox.java:显示关于窗口的类，当用户点击帮助菜单中的关于菜单项时会弹出关于对话框。
●Tools.java：FileTools是文件操作辅助类，可以实现文件的递归删除等。
●XMLController.java: JDOMTes是操作xml文件的类，用JDOM来操作xml文件，实现的功能有：（1）保存ftp服务器的文件列表（站内搜索时使用），递归的从ftp服务器读取列表，并存入一个xml文件中（文件的命名方法是：ip+用户名.xml）;以目录树的形式保存。
（2）根据文件名在文件中查找文件，站内搜索时使用。
（3）保存ftp服务器的信息：ip，端口（默认端口21不保存），用户名（默认anonymous 不保存），密码，最多存10个；存在resource\settings\ serversinfor.xml文件中。
（4）读取已存储的ftp服务器信息。
（5）从type.xml读取搜索的类型。
●Constants.java:放置系统运行时使用的一些常量，initcontent（）函数对所有常量进行初始化，这个函数在MainFrame中被调用一次。
iconHashMap是hash表，用于存放文件的系统图标。
●CustomizedController.java：包含自定义的控件类，java中的控件可能不能满足需求，需要自己定义某些属性。
这些控件会在创建界面时使用。
其中含有的类有：（1）CustomizedJTable 是表格类，设置表格的某些属性，如字体等。
（2）CustomizedTableCellRenderer是表格单元格绘制器类，主要用于显示文件的系统图标，和文件名。
（3）LeftPanel类的父类是JTabbedPane，用户显示主窗口左边的面板。
（4）RightPanel类的父类是JPanel，用户显示右边的主题部分，包括右上边的搜索及服务器选项，和中间的显示服务器文件的TabbedPane。
.（5）BottomPanel类是右下放显示下载和服务器信息的JTabbedPane。
（6）CustomizedJButton 是定义按钮类，更改了按钮的字体，java本身默认的字体不好看。
（7）CustomizedTableModel是表格类，实现单元格的不可编辑。
（8）CustomizedTableCellRenderer_Remote类是表格绘制器，在远程文件浏览器RemoteFilesPanel使用，用于显示文件名和文件图标。
（9）FontTableCellRenderer类是表格单元格绘制器，主要功能是设置字体。
（10）FontListCellRenderer类是下拉列表框单元格绘制器，主要用于设置字体。
（11）CustomizedJLabel类是自定义标签类，重新设置了标签的字体。
（12）CustomizedJTextField类是自定义文本框类，主要用于设置文本框的显示属性。
（13）CustomizedJMenu类是自定义菜单类，重新设置了菜单的字体。
（14）CustomizedJMenuItem类是自定义菜单项类，重新设置了菜单的字体。
（15）CustomizedListCellRenderer类是JComboBox即组合框单元格绘制器，用于在本地路径选择的下拉列表中显示磁盘图标。
●SearchResultReceiver.java,SearchResultReceiver是一个接口，主要用于返回搜索结果。
搜索完成后调用接口中的函数通知调用者。
其中主要有两个函数：（1）OnSearchFinished(String[] keywords,ArrayList[] resultset);result是一个10维的数组表result[10],result[i]是由类型为i的资源组成的数组。
i：0－9，和类型列表框中的顺序一致。
（2）OnSearchFinished(String[] keywords,ArrayList resultset);不分类型，将所有资源放在一个数组表中。
●FtpFrame.java:FtpFrame是程序主窗口类，类型为JFrame,是由三个分割窗口JSplitPane构成的。
jSplitPane_Left是左边的分割窗口，水平分割条上边显示本地文件框，下边是预览框；jSplitPane_Right是右边的分割窗口，水平分割条上边是服务器选项和ftp服务器文件显示的窗口，下边是下载和服务器信息显示窗口；jSplitPane_Whole是整体的分割窗口，垂直分割条，左边是jSplitPane_Lef，右边是jSplitPane_Right。
FtpFrame把LeftPanel，RightPanel，BottomPanel，PreviewWrapperPanel这几部分安装在相应的分割窗格中；LeftPanel，RightPanel，BottomPanel是在CustomizedController.Java中定义的，PreviewWrapperPanel是在Preview包中定义的。
●LeftPanelCtrl.java: LocalFilesPanel是本地文件面板，用表格来显示本地文件的信息。
上边是组合框，显示了磁盘分区通过这里可以改变根目录。
表格中显示了文件的信息，包括文件名，文件的系统图标，大小，最近修改日期，属性等。
选中一个文件后可以执行上载和删除操作。
文件夹会递归的删除。
GetCurrentPath（）函数返回当前的路径。
DisplayPathFiles（）函数在列表中显示指定目录下的文件。
●RightPanlCtrl.java：定义右上边的控件。
含有的类有：（1）FtpServerOptionPanel类是服务器连接选项面板，包含服务器地址，端口，用户名，密码等，还包括最上端的搜索选项。
openRemoteFilesPanel（）函数在下面的TabbedPane 中打开一个新的服务器面板，连接服务器。
（2）RemoteFilesPanel类的主要功能是连接Ftp服务器并显示文件。
这里会进行文件的上载，下载及预览等操作。
RemoteFilesPanel 的内部类TransferController负责调用FtpClient类提供的功能与服务器进行交互，完成用户指定的文件操作。
TransferController还有三个内部类：ConnThread类是负责连接服务器的线程（新开一个线程，目的是避免连接时阻塞），DownloadFileThread类是下载文件的线程，UploadFileThread类是上载文件的线程。
（3）SearchResultPanel类是显示搜索结果的类，它有两个子类SearchResultPanelWithinSearchEngine类的功能是在搜索引擎中搜索，SearchResultPanelWithinServer类的功能是站内搜索。
搜索引擎的搜索会调用search包中的程序，搜索引擎搜索完成后search包通过OnSearchFinished（）来通知SearchResultPanelWithinSearchEngine类，然后显示搜索结果。
（4）RightTabbedPane是显示ftp服务器文件表格的TabbedPane类。
BottomPanelCtrl.java：实现主窗口下部面板及控件，显示下载情况，服务器连接信息。
包含的主要类有：（1）RemoteMessPanel类是显示服务器连接信息的面板。
需要显示ftp服务器传回的信息，并在显示前进行编码转换，还需要显示本地的相关信息。
（2）DownloadingMessPanel类是显示资源下载信息的面板，显示下载资源的大小，下载速度，已用时间，剩余时间等信息。
3.5流程逻辑总体流程：4．模块2（client）设计说明4.1模块描述实现ftp客户端FtpClient，有两个文件FtpClient.java和FtpLoginException.java,前者具体实现了ftp协议，后者是为登录时可能抛出的异常而定义的类。
4.2功能实现ftp客户端FtpClient，实现了ftp协议，用于和ftp服务器通讯和数据传输。
4.3交互的模块ui4.4 模块设计该模块中的主要文件，文件中包含的主要类及其功能和与其它包的交互如下：FtpClient.java：含有类FtpClient,，该类会被ui包中的界面类调用，完成ftp功能。
其中要功能的实现有：在构造函数中根据ip和port建立与服务器的连接；登录服务器login（）（用户名，密码）；向服务器追加ascii文件appendAscii（）；向服务器追加二进制文件appendBinary（）；设置数据传输方式为二进制binary，ascii码scii（）；改变工作目录cd（String newdirectory）；返回上一级目录cdup（）；断开连接closeserver（）；删除文件 delete（文件名）；删除文件夹 rmdir（文件夹的名字）；用ascii模式下载文件getAscii（文件名）；用二进制方式下载文件getBinary（文件名）；取得服务器的响应字串 getResponseString()；列举当前目录下的文件list（），指定目录下的文件list（文件名）；创建文件夹mkdir（文件夹名）；上载Ascii文件putAscii(文件路径)，二进制putBinary（）。