对于详细设计说明书，有很多刚入行的小白对此有很多的迷惑，在这里我就接着多年的工作经验，并拿出曾经给负责的一个专案撰写的概要设计说明书来作为案例给大家展示一下，写得不好，其中也有很多欠缺之处，愿朋友们看过之后能够给出很好的批评，咱们在这里相互学习、共同进步！
1. 引言 1.1 修订记录
1.2 简述
在这片档案中，我们开始探讨每个模组该如何具体实现，每个实现中需要哪些演算法、属性、引数、资料结构、界面，并以此来完成“XXXX管理平台详细设计说明书”的工作。
1.3 编写目的
本说明书确定系统的详细功能模组和资料结构，为下阶段开发工作提供依据。
1.4 背景
本文根据相关资料制定，在分析了XXXX管理平台需求的基础上制定本规范，适用于XXXX管理平台的开发。
1.6 定义
必须保证程式正常的连线到服务器，并保持网络的畅通。
1.8 参考资料
根据概要设计说明书中的设计内容，对整个系统所需实现的功能以及系统的功能模组的划分和功能模组的具体实现过程提供详细的说明，为整个系统的开发、测试、评定和移交的提供基础。
2.2 详细设计方法和工具
（1）方法
（2）工具
（1）硬件环境
（2）软件环境
在确定目标系统的过程中，主要遵循了以下几个原则：
3.3 全域性变数
3.4 公用控制元件
（1）使用者物件
（2）全域性结构
（3）全域性函式
（4）公用视窗
3.6 主视窗
系统主视窗继承自模板模式。当视窗开启时根据网络卡地址获取栏目程式码及名称，呼叫父类函式设定栏目及管理员资讯。为减少访问数据库次数，提高查询速度，将常用资料表：功能模组、预设条件、栏目程式码、使用者程式码、管理性质、模组编码、编码设定、编码明细、通用模组、独立功能、列表资讯下载到本地快取中，即将其储存到全域性结构中。
3.7 主选单
系统主选单继承自基础架构。为了方便查询功能的使用及扩充套件，所有查询功能均不挂在选单项中，而是通过各功能模组所对应的视窗名称将其开启，因此主选单只需增加以下专案：
功能：
使用者界面采用扁平化的设计风格，美观和简洁的同时，便于使用者进行操作，也增加了整个系统执行的稳定性、载入能力。
4.1 使用者界面设计规则
（1）字型
PingFang SC、Helvetics Neue、Arial、Hiragino Sans GB、Microsoft Yahei、微软雅黑、STHeiti、华文细黑、sans-serif，正常体/400微粗体，（12至20）px，黑色/白色（打印文字不在此限）。
（2）风格
采用全屏网页设计，扁平化、视差化的化繁为简的设计思维，让整个网站的整体性、统一性、灵活性、自适应性、流畅性得到了相对的提高，也使得平台的功能处理和管理能力在这些特点的加持之下得到综合性的展示。
（3）色系
（1）控制元件
1）尺寸
在合理的布局下尽可能多的显示控制元件内的内容。
2）布局
按照操作流程或浏览顺序自左至右、由上而下的排放各种控制元件，使界面整体协调、简洁、美观大方。
3）自适应父物件的尺寸改变
控制元件应具有自适应父物件的尺寸改变的能力，当父物件的尺寸发生变化时，控制元件应能自动改变自己的尺寸并使界面保持整体协调，尽量减少因父物件的尺寸改变而带来的操作或浏览上的不便。
5. 模组结构设计 5.1 概述
XXXX管理平台主要有使用者管理、工程模型、信访管理、进度管理、质量管理、安全管理、风险管理、监测视觉化、投资管理、腾地管理、运维管理、档案管理、工程周报、视讯监控14个功能模组，根据这些功能模组，以对应的结构图对其进行解析，用更加简单的方式来展示每一个功能模组的基本结构和主要的功能点。
5.2 使用者管理模组
（1）概述
使用者管理模组分为使用者列表和使用者组列表两个大项，根据专案的实际需求，可建立不同的使用者多使用者角色，同时该角色可分配相应的操作许可权。
（2）模组所涉及的档案
（3）使用者管理模组结构图
5.3 工程模型
（1）概述
工程模型可以进行web浏览和漫游，可以通过旋转平移等简单操作检视整个模型，并可通过模型树快速点选构件，并可进行隐藏，亦可以通过剖面框、开洞等控制元件对模型进行多角度多方位的检视。
（2）模组所涉及的档案
（3）工程模型模组结构图
5.4 信访管理
（1）概述
将12345、投诉信箱等投诉渠道获得的针对工程各施工工地产生的投诉工单，根据来源、时间、工段、地区、型别进行分类统计并关联模型，形成分析图表，并且推送相关施工单位进行情况的核实与反馈，帮助指挥部对确实存在的问题进行监管与督促整改。
（2）模组所涉及的档案
（3）信访管理模组结构图
5.5 进度管理
（1）概述
分析利用WBS编辑器，完成施工段划分、WBS和进度计划建立，建立WBS与Microsoft Project的双向连结；通过BIM模型，对施工进度进行查询、调整和控制，使计划进度和实际进度既可以用甘特图表示，也可以以动态的3D图形展现出来，实现施工进度的4D动态管理;可提供任意WBS节点或3D施工段及构件工程资讯的实时查询、计划与实际进度的追踪和分析等功能。
（2）模组所涉及的档案
（3）进度管理模组结构图
5.6 质量管理
（1）概述
主要以验收资料为依据，围绕部件、区域和时间展开分析，并给出结论和建议。
系统将质量或检验报告与BIM资讯模型相关联，可以实时查询任意WBS节点或施工段及构件的施工质量情况，并可自动生成工程质量统计分析报表，使相关人员能够对工程质量问题进行检视及处理回复。
（2）模组所涉及的档案
（3）质量管理模组结构图
5.7 安全管理
（1）概述
主要以验收资料为依据，围绕部件、区域和时间展开分析，并给出结论和建议。
系统将安全报告与BIM资讯模型相关联，可以实时查询任意WBS节点或施工段及构件的施工安全情况，并可自动生成工程安全统计分析报表，使相关人员能够对工程安全问题进行检视及处理回复。
（2）模组所涉及的档案
（3）安全管理模组结构图
5.8 风险管理
（1）概述
通过设定风险判定规则或相关人员手动录入相关资料，针对不同风险源位置以及风险等级，标注相应的风险或安全标识，亦可实时展现工程风险状态分布。相关人员也可以通过移动端拍照和定位功能，实现风险监察。
（2）模组所涉及的档案
（3）风险管理模组结构图
5.9 监测视觉化
（1）概述
以BIM模型为基础，将施工方、监理方以及第三方监测资料与4D资讯模型相关联，可以反映了当前工程安全状况（危险区域和预警区域）、实时查询任意施工段及周边环境的安全情况，并可进行预警资讯自动推送。
（2）模组所涉及的档案
（3）监测视觉化模组结构图
5.10 投资管理
（1）概述
基于BIM模型自动生成工程量表，并可自动根据进度情况生成周、月、季度的工程量统计和指定时间段的工程量，并可以根据施工进度预测下一计算区间的工程量。
（2）模组所涉及的档案
（3）投资管理模组结构图
5.11 腾地管理
（1）概述
通过相关人员录入的腾地相关资讯，对工程的腾地情况进行整理汇总，包括腾地的地点、所属区属、长度、面积等。并与模型相关联，直观反映腾地的完成情况以及未完成的原因。
（2）模组所涉及的档案
（3）腾地管理模组结构图
5.12 运维管理
（1）概述
目标是为后期的运维提供一套完整的设施和装置资讯，便于后期运营过程中使用。
该系统包括装置管理、设施管理两个部分。
（2）模组所涉及的档案
（3）运维管理模组结构图
5.13 档案管理
（1）概述
对设计方上传的BIM成果进行管理，设计方BIM成果包括市政管线综合、交通碰撞报告等应用成果，按照版本和类别进行管理和呼叫，方便资料的查询和整理。
（2）模组所涉及的档案
（3）档案管理模组结构图
5.14 工程周报
（1）概述
基于平台所管理的工程量数，每周对档案进行填报和检视。
（2）模组所涉及的档案
（3）工程周报模组结构图
5.15 视讯监控
（1）概述
通过与施工现场监控摄像头的资料对接，能够获取即时的监控影象，相关人员也能够控制摄像头的方向，实现通过平台即能观察施工现场的具体情况。
（2）模组所涉及的档案
（3）视讯监控模组结构图
6. 平台各模组的设计说明 6.1 概述
平台各模组的设计说明包括各模组业务流程图、各模组的详细设计说明表、视窗物件说明表、相互关系说明表，从多方面对各个模组的功能、型别、效能、演算法逻辑、界面用详细多元精准的表结构进行阐述，以求此种描述方法来让专案档案更加的全面和详细。
6.2 使用者管理模组
（1）使用者管理业务流程图
（2）使用者管理设计说明
1）模组详细设计说明
使用者管理详细设计说明表：
编号：说明01
2）视窗物件说明
使用者管理视窗物件说明表：
编号：视窗01
3）模组相互关系设计说明
使用者管理相互关系说明表：
编号：关系01
6.3 工程模型模组
（1）工程模型业务流程图
（2）工程模型设计说明
1）模组详细设计说明
工程模型详细设计说明表：
编号：说明02
2）视窗物件说明
工程模型视窗物件说明表
编号：视窗02
3）模组相互关系设计说明
工程模型相互关系说明表
编号：关系01
6.4 信访管理模组
（1）信访管理业务流程图
（2）信访管理设计说明
1）模组详细设计说明
信访管理详细设计说明表
编号：说明03
2）视窗物件说明
信访管理视窗物件说明表
编号：视窗03
3） 模组相互关系设计说明
信访管理相互关系说明表
编号：关系03
6.5 进度管理模组
（1）进度管理业务流程图
（2）进度管理设计说明
1）模组详细设计说明
进度管理详细设计说明表
编号：说明04
2）视窗物件说明
进度管理视窗物件说明表
编号：视窗04
3）模组相互关系设计说明
进度管理相互关系说明表
编号：关系04
6.6 质量管理模组
（1）质量管理业务流程图
（2）质量管理设计说明
1）模组详细设计说明
质量管理详细设计说明表
编号：说明05
2）视窗物件说明
质量管理视窗物件说明表
编号：视窗05
3）模组相互关系设计说明
质量管理相互关系说明表
编号：关系05
6.7 安全管理模组
（1）安全管理业务流程图
（2）安全管理设计说明
1）模组详细设计说明
安全管理详细设计说明表
编号：说明06
2）视窗物件说明
安全管理视窗物件说明表
编号：视窗06
3）模组相互关系设计说明
安全管理相互关系说明表
编号：关系06
6.8 风险管理模组
（1）风险管理业务流程图
（2）风险管理设计说明
1）模组详细设计说明
风险管理详细设计说明表
编号：说明07
2）视窗物件说明
风险管理视窗物件说明表
编号：视窗07
3）模组相互关系设计说明
风险管理相互关系说明表
编号：关系07
6.9 监测视觉化模组
（1）监测视觉化业务流程图
（2）监测视觉化设计说明
1）模组详细设计说明
监测视觉化详细设计说明表
编号：说明08
2）视窗物件说明
监测视觉化视窗物件说明表
编号：视窗08
3）模组相互关系设计说明
监测视觉化相互关系说明表
编号：关系08
6.10 投资管理模组
（1）投资管理业务流程图
（2）投资管理设计说明
1）模组详细设计说明
投资管理详细设计说明表
编号：说明09
2）视窗物件说明
投资管理视窗物件说明表
编号：视窗09
3）模组相互关系设计说明
投资管理相互关系说明表
编号：关系09
6.11 腾地管理模组
（1）腾地管理业务流程图
（2）腾地管理设计说明
1）模组详细设计说明
腾地管理详细设计说明表
编号：说明10
2)视窗物件说明
腾地管理视窗物件说明表
编号：视窗10
3)模组相互关系设计说明
腾地管理相互关系说明表
编号：关系10
6.12 运维管理模组
（1）运维管理业务流程图
（2）运维管理设计说明
1）模组详细设计说明
运维管理详细设计说明表
编号：说明11
2）视窗物件说明
运维管理视窗物件说明表
编号：视窗11
3）模组相互关系设计说明
运维管理相互关系说明表
编号：关系11
6.13 档案管理模组
（1）档案管理业务流程图
（2）档案管理设计说明
1）模组详细设计说明
档案管理详细设计说明表
编号：说明12
2）视窗物件说明
档案管理视窗物件说明表
编号：视窗12
3）模组相互关系设计说明
档案管理相互关系说明表
编号：关系12
6.14 工程周报模组
（1）工程周报业务流程图
（2）工程周报设计说明
1）模组详细设计说明
工程周报详细设计说明表
编号：说明13
2）视窗物件说明
工程周报视窗物件说明表
编号：视窗13
3）模组相互关系设计说明
工程周报相互关系说明表
编号：关系13
6.15 视讯监控模组
（1）视讯监控业务流程图
（2）视讯监控设计说明
1）模组详细设计说明
视讯监控详细设计说明表
编号：说明14
2）视窗物件说明
视讯监控视窗物件说明表
编号：视窗14
3）模组相互关系设计说明
视讯监控相互关系说明表
编号：说明14
7. 档案附录 7.1 概述
这一部分主要是对详细设计档案中未提及或者有所遗漏的分析内容进行补充，这些和以上部分相比并不是必需的，所以将这些不必需的内容在附录这里进行一一阐述。
7.2 资料储存设计描述
（1）结构化资料储存描述
用于储存来自客户端的业务资料，并满足对所储存资料的安全、检索、统计等需求。
结构化资料常使用数据库来储存，数据库目前主要分为以下两大类：
根据业务场景的需要，BIM资料中心的建设选用主流的关系型数据库和非关系型数据库进行搭建。
（2）非结构化资料储存描述
用于储存档案、图片、视讯等非结构化资料，并满足使用者对这类资料的检索，存取，由于非结构化资料储存要解决的关键问题是：
基于以上问题，非结构化资料的储存解决的核心是协调多块硬盘对档案进行统一的读写，增加单个读写事务效能。
GridFS是 MongoDB的一个用来储存/获取大型资料（影象、音讯、视讯等型别的档案）的规范。它相当于一个储存档案的档案系统，但它的资料储存在 MongoDB的集合中。GridFS能储存超过档案尺寸限制（16 MB）的档案。
GridFS将档案分解成块，将每块资料储存在不同的档案中，每块大小最高为 255 KB，通过对分片逻辑结构的管理满足对使得大档案具备分散式储存的能力，借助于MongoDB的分散式管理，提高资料中心对大档案的分散式储存、检索。
（3）日志资料储存描述
ELK架构功能示意图，如下：
Logstash：通过Logstash的日志收集功能，对服务端的硬件效能日志，应用请求的访问、响应日志、数据库CUDI日志进行收集，根据各类日志的格式，在Logstash中编写日志收集规则。
Elasticsearch：储存通过Logstash收集到的日志资讯，用于后续查询；ES的使用并不仅限于对日志的收集，所有结构化的资料都可以储存在ES中，ES是一个实时的分散式搜寻分析引擎， 它能让你以一个之前从未有过的速度和规模，去探索结构化资料。
ES被用作全文检索、结构化搜寻、分析以及这三个功能的组合，通过ES储存的资料具备以下能力：
Kibana：是一个针对Elasticsearch的开源分析及视觉化平台，用来搜寻、检视互动储存在Elasticsearch索引中的资料。使用Kibana，可以通过各种图表进行高阶资料分析及展示。
Kibana让海量资料更容易理解。它操作简单，基于浏览器的使用者界面可以快速建立仪表板（dashboard）实时显示Elasticsearch查询动态。
Kibana Dashboard界面截图，如下：
使用Kibana制作图表时所使用的资料检索规则是使用Lucene语句编写的聚合查询规则，Lucene是一套用于全文检索和搜寻的开放源代码程式库，由Apache软件基金会支援和提供。Lucene提供了一个简单却强大的应用程序界面，能够做全文索引和搜寻，在Java开发环境里Lucene是一个成熟的免费开放源代码工具。
就其本身而论，Lucene是现在并且是这几年，最受欢迎的免费Java资讯检索程式库；
7.3 测试计划
对本系统进行单体测试的计划，主要有一下几个方面：
说明准备在本系统中安排的注释，如：
尚未解决的问题
暂无。
结语
如果这篇详细设计档案当您有什么疑问的话，请以以上的参考资料内列出的档案内容一同研读，整体结构请以《XXXX管理平台——概要设计说明书》为基础。
另外请路过的朋友们多多支援哈，笔者在这里先谢谢了，以后会有更多优质的文章在这个平台上进行释出，请尽请期待呦！
本文由 @卧枕江山 原创释出于人人都是产品经理。未经许可，禁止转载
题图来自Unsplash，基于CC0协议
