首頁 > 運營推廣 > 正文

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

2019-12-05 16:02:01 來源:金橙教程網 作者:admin7 瀏覽:86次 「手機版」

設計說明

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

1. 引言

1.1 修訂記錄

1.2 簡述

在這片文檔中,我們開始探討每個模塊該如何具體實現,每個實現中需要哪些算法、屬性、參數、數據結構、接口,并以此來完成“XXXX管理平臺詳細設計說明書”的工作。

1.3 編寫目的

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

1.4 背景

軟件系統的名稱:XXXX管理平臺

本項目的任務提出者:XXX市經濟和信息化委員會

開發本項目公司名稱:XXX城投公路投資(集團)有限公司、XXX市地下空間設計研究總院有限公司(地下院)

公司開發項目組名稱:基于BIM協同管理平臺研發組

軟件系統的用戶對象:建設單位、設計院、施工單位

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

1.5 范圍

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管理平臺——概要設計說明書》為基礎。

另外請路過的朋友們多多支持哈,筆者在這里先謝謝了,以后會有更多優質的文章在這個平臺上進行發布,請盡請期待呦!

題圖來自Unsplash,基于CC0協議

相關閱讀

如何編輯交互設計說明書

當你搜索并查閱了很多網上資料后,仍可能不會編輯交互設計說明書。那么究竟該怎么編輯交互設計說明書呢?在編輯的過程中又有哪些要點

【軟件工程】——詳細設計說明書

1引言 1.1編寫目的 該文檔在概要設計的基礎上,進一步的細化系統結構,展示了軟件結構的圖標,物理設計、數據結構設計、及算法設計、詳

一份全面的“概要設計說明書”是怎樣的?

對于概要設計說明書,有很多剛入行的小白對此有很多的迷惑,在這里我就接著多年的工作經驗,并拿出曾經給負責的一個項目撰寫的概要設計

互聯網+廢品回收項目數據庫設計說明書

本項目設計書為筆者軟件工程課的作業,由于時間有限較為粗糙,不合理之處還望指出并改正。 互聯網+廢品回收項目可行性分析報告 互聯

(責任編輯:jjjccc)

關鍵詞:設計說明書

福彩3d字谜画谜藏机图