一份全面的“詳細設計說明書”是怎樣的？

藥箱設計說明怎麼寫

加關注，帶你看世界

對於詳細設計說明書，有很多剛入行的小白對此有很多的迷惑，在這裡我就接著多年的工作經驗，並拿出曾經給負責的一個專案撰寫的概要設計說明書來作為案例給大家展示一下，寫得不好，其中也有很多欠缺之處，願朋友們看過之後能夠給出很好的批評，咱們在這裡相互學習、共同進步！

1。 引言

1。1 修訂記錄

1。2 簡述

在這片文件中，我們開始探討每個模組該如何具體實現，每個實現中需要哪些演算法、屬性、引數、資料結構、介面，並以此來完成“XXXX管理平臺詳細設計說明書”的工作。

1。3 編寫目的

本說明書確定系統的詳細功能模組和資料結構，為下階段開發工作提供依據。

1。4 背景

軟體系統的名稱：XXXX管理平臺

本專案的任務提出者：XXX市經濟和資訊化委員會

開發本專案公司名稱：XXX城投公路投資（集團）有限公司、XXX市地下空間設計研究總院有限公司（地下院）

公司開發專案組名稱：基於BIM協同管理平臺研發組

軟體系統的使用者物件：建設單位、設計院、施工單位

這個系統的基本概念：結合BIM、GIS、Web等技術搭建一個XXXX管理平臺，實現各參與方的協同交流、資訊共享，實現對進度、成本、質量安全的動態掌控，實現視覺化、智慧化和移動化管理，為管理和決策提供幫助，提升專案的精細化管理水平，提高工程管理和決策效率，減少返工浪費，保證工期，提高工程質量和投資效益。

1。5 範圍

本文根據相關資料制定，在分析了XXXX管理平臺需求的基礎上制定本規範，適用於XXXX管理平臺的開發。

1。6 定義

名稱：詳細設計說明書。

MIS：管理資訊平臺。

質量技術交底：對一個工程專案開始時提出的要達到的質量要求。

人力強度：一個工程專案每個時間段投入人力的分佈。

1。7 限制條件

必須保證程式正常的連線到伺服器，並保持網路的暢通。

1。8 參考資料

《XXXX管理平臺——計劃任務書》

《XXX市資訊化發展專項資金專案建設方案編制大綱——XXXX管理平臺》

《XXXX管理平臺——課題綜述報告》

《XXXX管理平臺——技術報告》

《XXXX管理平臺——概要設計說明書》

《XXXX管理平臺——任務書蓋章版》

《XXXX管理平臺——建設方案》

《XXXX管理平臺——專案研發計劃說明書》

2。 任務描述

2。1 目標

根據概要設計說明書中的設計內容，對整個系統所需實現的功能以及系統的功能模組的劃分和功能模組的具體實現過程提供詳細的說明，為整個系統的開發、測試、評定和移交的提供基礎。

2。2 詳細設計方法和工具

（1）方法

模組結構圖；

模組業務流程圖；

系統整頁截圖；

詳細設計說明表；

視窗物件說明表；

模組相互關係表。

（2）工具

vsdx作圖工具：針對於模組業務流程圖；

axure原型工具：針對於模組結構圖；

QQ自帶裁切工具：針對於業務流程圖和結構圖大小之間的設定；

Goole Chrome高效截圖外掛：針對於系統整頁截圖。

2。3 主要設計

軟體開發生命週期方法和敏捷開發相結合。

自定向下，逐步求精的結構化的設計。

模板化元件的綜合和多元化視窗利用的設計理念。

2。4 環境

（1）硬體環境

windows伺服器：CPU4核8G/作業系統windows server2008R2/SSD雲盤40G/資料盤（高效雲盤）512G；

linuxs伺服器：CPU4核8G/作業系統04 64/SSD雲盤40G/資料盤（高效雲盤）256G。

（2）軟體環境

開發系統：CentOS；

作業系統：win9及以上；

資料庫：Mysql；

網路協議：TCP/IP；

開發環境：Linux；

使用軟體：Windows Server 2008。

3。 系統設計

3。1 設計原則

在確定目標系統的過程中，主要遵循了以下幾個原則：

目標系統基本上完整地實現IPSec協議族，完全支援VPN的要求；

目標系統的伺服器端一定要建立在具有自主版權的核心作業系統之上；

目標系統的客戶端使用方便、介面友好、配置和管理簡單靈活。

3。2 程式檔案

3。3 全域性變數

3。4 公用控制元件

（1）使用者物件

（2）全域性結構

（3）全域性函式

（4）公用視窗

3。6 主視窗

系統主視窗繼承自模板模式。當視窗開啟時根據網絡卡地址獲取欄目程式碼及名稱，呼叫父類函式設定欄目及管理員資訊。為減少訪問資料庫次數，提高查詢速度，將常用資料表：功能模組、預設條件、欄目程式碼、使用者程式碼、管理性質、模組編碼、編碼設定、編碼明細、通用模組、獨立功能、列表資訊下載到本地快取中，即將其儲存到全域性結構中。

3。7 主選單

系統主選單繼承自基礎架構。為了方便查詢功能的使用及擴充套件，所有查詢功能均不掛在選單項中，而是透過各功能模組所對應的視窗名稱將其開啟，因此主菜單隻需增加以下專案：

功能：

開啟：開啟功能模組視窗。

關閉：關閉功能模組視窗。

編輯：對功能模組進行維護。

許可權：設定使用者查詢許可權。

重新整理：重新檢索功能模組表，用於對功能模組修改後重新整理螢幕。

4。 介面設計要求

使用者介面採用扁平化的設計風格，美觀和簡潔的同時，便於使用者進行操作，也增加了整個系統執行的穩定性、載入能力。

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）結構化資料儲存描述

用於儲存來自客戶端的業務資料，並滿足對所儲存資料的安全、檢索、統計等需求。

結構化資料常使用資料庫來儲存，資料庫目前主要分為以下兩大類：

關係型資料庫（SQL）：建立在關係模型基礎上的資料庫，藉助於集合代數等數學概念和方法來處理資料庫中的資料。現實世界中的各種實體以及實體之間的各種聯絡均用關係模型來表示，可以用SQL語句方便的在一個表以及多個表之間做非常複雜的資料查詢；關係型資料庫支援複雜的事務管理，對於一致性要求較高的操作，常藉助於資料庫的事務管理保證程式操作的一致性，常見的有：SQLServer（付費）、Oracle（付費）、MySQL、DB2（付費）等；

非關係型資料庫（NOSQL）：其資料儲存可以不固定的表格模式，也經常會避免使用SQL的JOIN操作，一般有水平可擴充套件性的特徵，由於減少了對資料依賴關係的管理，對資料管理的重點放在了儲存和檢索上，因此相對SQL資料庫，NOSQL資料庫具備相抵較高的效能以及橫向擴充套件能力，常用的有MongoDB、ElasticSearch等。

根據業務場景的需要，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儲存的資料具備以下能力：

分散式儲存能力，ES支援叢集部署，在適合的硬體配置下可以用於儲存海量資料；

豐富的查詢介面，ES的查詢介面遵循RESTful API規範，透過ES可以在不需要後端程式碼介入的情況下直接透過RESTful API對資料進行查詢和寫入；

透過RESTful API進行復雜的聚合搜尋，而不僅限於普通的全文檢索查詢。

Kibana：是一個針對Elasticsearch的開源分析及視覺化平臺，用來搜尋、檢視互動儲存在Elasticsearch索引中的資料。使用Kibana，可以透過各種圖表進行高階資料分析及展示。

Kibana讓海量資料更容易理解。它操作簡單，基於瀏覽器的使用者介面可以快速建立儀表板（dashboard）實時顯示Elasticsearch查詢動態。

Kibana Dashboard介面截圖，如下：

使用Kibana製作圖表時所使用的資料檢索規則是使用Lucene語句編寫的聚合查詢規則，Lucene是一套用於全文檢索和搜尋的開放原始碼程式庫，由Apache軟體基金會支援和提供。Lucene提供了一個簡單卻強大的應用程式介面，能夠做全文索引和搜尋，在Java開發環境裡Lucene是一個成熟的免費開放原始碼工具。

就其本身而論，Lucene是現在並且是這幾年，最受歡迎的免費Java資訊檢索程式庫；

7。3 測試計劃

對本系統進行單體測試的計劃，主要有一下幾個方面：

對測試的各個方面的技術要求；

對測試的各個方面的輸入資料；

對測試問題的記錄方式；

對測試流程的控制方式；

對測試時間段或者階段性的設定；

對測試的預期效果、進度安排、人員職責、裝置條件驅動程式及其各個模組等的規定。

7。4 各模組的註釋設計

說明準備在本系統中安排的註釋，如：

註釋說明各個模組開始編寫的時間，編寫人員，修改的時間，編寫的名稱，及其基本功能。

註釋說明各個模組的主要功能開始編寫的功能簡述、編寫人員、編寫的時間。

註釋說明各個模組延伸副模組的編寫的時間，編寫人員，修改的時間，編寫的名稱，及其基本功能。

註釋說明各個模組延伸副模組的主要功能開始編寫的功能簡述、編寫人員、編寫的時間。

加在各個模組的一些限制條件的註釋說明和條件要求。

加在各分支點的註釋說明各種條件。

尚未解決的問題

暫無。

結語

如果這篇詳細設計文件當您有什麼疑問的話，請以以上的參考資料內列出的文件內容一同研讀，整體結構請以《XXXX管理平臺——概要設計說明書》為基礎。

另外請路過的朋友們多多支援哈，筆者在這裡先謝謝了，以後會有更多優質的文章在這個平臺上進行釋出，請盡請期待呦！

#宣告#