詳細設計說明書
1引言
1.1編寫目的
編寫詳細設計說明書的目的就是為程序員寫出實際的程序代碼提供依據。它是軟件詳細設計階段所有任務和所有相關人員所需的參考資料.
1.2背景
說明:
a. 軟件名稱:BIM工程信息管理系統;
b. 項目提出者:**科技技術委員會
c. 開發者:**研發部
d. 用戶:適用於隧道,橋梁 BIM施工
e. 系統運行:Windows7/8
1.3定義
用戶接口:是指一個程序與程序使用者交互的部分。
算法:詳細設計中實現某項功能的數據處理流程及處理方法。
SDK:Software Development Kit 即軟件開發工具包。
VS: Visual Studio
MSSQL:微軟SQL Server
1.4參考資料
列出有關的參考資料:
a. 根據需求分析文檔的功能需求
b. IT項目管理 [機械出版社會]
2程序系統的結構
本程序系統內的每個程序(包括每個模塊和子程序)的名稱、標識符和它們之間 的層次結構關系:
系統分為以下幾個模塊:系統基礎模塊功能,系統BIM屬性功能模塊,系統插件管理模塊,模型關聯信息模塊,系統可視集成模塊,系統工程簡介與概述,施工管理模塊
3系統基礎模塊[機構管理]
3.1程序描述
主要是考慮到集團類型的公司下一般都有很多分公司。管理員通過機構管理可以添加對應的機構信息。可以新增,編輯,刪除 等功能
3.2功能
說明該程序應具有的功能,可采用IPO圖:
3.3性能
靈活性:窗口響應絕大部分的快捷菜單和控制面板操作
時間特性:響應鼠標單擊的時間在2—3秒之間
3.4輸人項
輸入的數據是用戶執行的各種操作,包括鼠標、鍵盤等操作。。
3.5輸出項
輸出是從數據庫中讀取的數據,或錯誤警告信息。
3.6算法
本部分沒有采用自定義的算法。
3.7接口
硬件接口:主要就是WCF 以TCP/IP層中的網絡接口層
軟件接口:具體來說開發中可能使用到的ADO的常用對象有以下幾個:
(1)連接對象(Connection):用來連接數據庫。
(2)記錄集對象(RecordSet):用來保存查詢語句的返回結果。
(3)命令對象(Command):用來執行SQL語句或者SQL Server的存儲過程。
(4)參數對象(Parameter):用來為存儲過程或查詢提供參數。
3.8存儲分配
本程序在高級語言C#進行編碼,直接的內存分配由C#運行時分配。
3.9注釋設計
說明准備在本程序中安排的注釋,
a. 加在模塊首部的注釋;//簡介:開發人員: 時間
b. 加在各分枝點處的注釋;//說明程序
c. 對各變量的功能、范圍、缺省條件等所加的注釋;
d. 對使用的邏輯所加的注釋等等。
3.10限制條件
(1)由於本系統的開發將是基於Window的C/S 結構,所以客戶端的語言使用Win form,服務器端的語言使用WCF,開發人員將不能用其他的開發語言(編寫組件除外)。而數據庫也將隨之采用SQL Server2012。
(2)開發人員在編寫代碼的過程中需要嚴格按照軟件工程的要求來進行,以利於接下來的測試和維護及升級。
3.11測試計划
測試計划按照測試經理的安排完成項目的測試需要。
4系統基礎模塊[部門管理]
4.1程序描述
主要是考慮到機構一般都有很多部門。管理員通過機構管理可以添加對應的部門信息。可以新增,編輯,刪除 等功能
4.2功能
說明該程序應具有的功能,可采用IPO圖:
4.3性能
靈活性:窗口響應絕大部分的快捷菜單和控制面板操作
時間特性:響應鼠標單擊的時間在2—3秒之間
4.4輸人項
輸入的數據是用戶執行的各種操作,包括鼠標、鍵盤等操作。。
4.5輸出項
輸出是從數據庫中讀取的數據,或錯誤警告信息。
4.6算法
本部分沒有采用自定義的算法。
4.7接口
硬件接口:主要就是WCF 以TCP/IP層中的網絡接口層
軟件接口:具體來說開發中可能使用到的ADO的常用對象有以下幾個:
(1)連接對象(Connection):用來連接數據庫。
(2)記錄集對象(RecordSet):用來保存查詢語句的返回結果。
(3)命令對象(Command):用來執行SQL語句或者SQL Server的存儲過程。
(4)參數對象(Parameter):用來為存儲過程或查詢提供參數。
4.8存儲分配
本程序在高級語言C#進行編碼,直接的內存分配由C#運行時分配。
4.9注釋設計
說明准備在本程序中安排的注釋,
e. 加在模塊首部的注釋;//簡介:開發人員: 時間
f. 加在各分枝點處的注釋;//說明程序
g. 對各變量的功能、范圍、缺省條件等所加的注釋;
h. 對使用的邏輯所加的注釋等等。
4.10限制條件
(1)由於本系統的開發將是基於Window的C/S 結構,所以客戶端的語言使用Win form,服務器端的語言使用WCF,開發人員將不能用其他的開發語言(編寫組件除外)。而數據庫也將隨之采用SQL Server2012。
(2)開發人員在編寫代碼的過程中需要嚴格按照軟件工程的要求來進行,以利於接下來的測試和維護及升級。
4.11測試計划
測試計划按照測試經理的安排完成項目的測試需要。
5系統基礎模塊[用戶與角色管理]
5.1程序描述
管理員可以對已注冊用戶進行刪除、修改信息、查詢等不同功能
管理員可以對已角色信息進行刪除、修改信息、查詢等不同功能
5.2功能
說明該程序應具有的功能,可采用IPO圖:
圖:用戶管理
圖:角色管理
5.3性能
靈活性:窗口響應絕大部分的快捷菜單和控制面板操作
時間特性:響應鼠標單擊的時間在2—3秒之間
5.4輸人項
輸入的數據是用戶執行的各種操作,包括鼠標、鍵盤等操作。。
5.5輸出項
輸出是從數據庫中讀取的數據,或錯誤警告信息。
5.6算法
本部分沒有采用自定義的算法。
5.7接口
硬件接口:主要就是WCF 以TCP/IP層中的網絡接口層
軟件接口:具體來說開發中可能使用到的ADO的常用對象有以下幾個:
(1)連接對象(Connection):用來連接數據庫。
(2)記錄集對象(RecordSet):用來保存查詢語句的返回結果。
(3)命令對象(Command):用來執行SQL語句或者SQL Server的存儲過程。
(4)參數對象(Parameter):用來為存儲過程或查詢提供參數。
5.8存儲分配
本程序在高級語言C#進行編碼,直接的內存分配由C#運行時分配。
4.9注釋設計
說明准備在本程序中安排的注釋,
i. 加在模塊首部的注釋;//簡介:開發人員: 時間
j. 加在各分枝點處的注釋;//說明程序
k. 對各變量的功能、范圍、缺省條件等所加的注釋;
l. 對使用的邏輯所加的注釋等等。
5.10限制條件
(1)由於本系統的開發將是基於Window的C/S 結構,所以客戶端的語言使用Win form,服務器端的語言使用WCF,開發人員將不能用其他的開發語言(編寫組件除外)。而數據庫也將隨之采用SQL Server2012。
(2)開發人員在編寫代碼的過程中需要嚴格按照軟件工程的要求來進行,以利於接下來的測試和維護及升級。
5.11測試計划
......
6系統基礎模塊[系統權限菜單管理]
6.1程序描述
主要是對系統功能菜單的管理,進行對菜單的分組,模塊的划分 等信息.以及插件的加載。等信息管理、
6.2功能
說明該程序應具有的功能,可采用IPO圖:
6.3性能
靈活性:窗口響應絕大部分的快捷菜單和控制面板操作
時間特性:響應鼠標單擊的時間在2—3秒之間
6.4輸人項
輸入的數據是用戶執行的各種操作,包括鼠標、鍵盤等操作。。
6.5輸出項
輸出是從數據庫中讀取的數據,或錯誤警告信息。
6.6算法
本部分沒有采用自定義的算法。
6.7接口
硬件接口:主要就是WCF 以TCP/IP層中的網絡接口層
軟件接口:具體來說開發中可能使用到的ADO的常用對象有以下幾個:
(1)連接對象(Connection):用來連接數據庫。
(2)記錄集對象(RecordSet):用來保存查詢語句的返回結果。
(3)命令對象(Command):用來執行SQL語句或者SQL Server的存儲過程。
(4)參數對象(Parameter):用來為存儲過程或查詢提供參數。
6.8存儲分配
本程序在高級語言C#進行編碼,直接的內存分配由C#運行時分配。
6.9注釋設計
說明准備在本程序中安排的注釋,
m. 加在模塊首部的注釋;//簡介:開發人員: 時間
n. 加在各分枝點處的注釋;//說明程序
- o. 對各變量的功能、范圍、缺省條件等所加的注釋;
p. 對使用的邏輯所加的注釋等等。
6.10限制條件
(1)由於本系統的開發將是基於Window的C/S 結構,所以客戶端的語言使用Win form,服務器端的語言使用WCF,開發人員將不能用其他的開發語言(編寫組件除外)。而數據庫也將隨之采用SQL Server2012。
(2)開發人員在編寫代碼的過程中需要嚴格按照軟件工程的要求來進行,以利於接下來的測試和維護及升級。
6.11測試計划
......
7系統基礎模塊[權限信息管理]
7.1程序描述
主要是對角色和用戶信息授權信息管理.
7.2功能
說明該程序應具有的功能,可采用IPO圖:
7.3性能
靈活性:窗口響應絕大部分的快捷菜單和控制面板操作
時間特性:響應鼠標單擊的時間在5—10秒之間
7.4輸人項
輸入的數據是用戶執行的各種操作,包括鼠標、鍵盤等操作。。
7.5輸出項
輸出是從數據庫中讀取的數據,或錯誤警告信息。
7.6算法
本部分沒有采用自定義的算法。
7.7接口
硬件接口:主要就是WCF 以TCP/IP層中的網絡接口層
軟件接口:具體來說開發中可能使用到的ADO的常用對象有以下幾個:
(1)連接對象(Connection):用來連接數據庫。
(2)記錄集對象(RecordSet):用來保存查詢語句的返回結果。
(3)命令對象(Command):用來執行SQL語句或者SQL Server的存儲過程。
(4)參數對象(Parameter):用來為存儲過程或查詢提供參數。
7.8存儲分配
本程序在高級語言C#進行編碼,直接的內存分配由C#運行時分配。
7.9注釋設計
說明准備在本程序中安排的注釋,
q. 加在模塊首部的注釋;//簡介:開發人員: 時間
r. 加在各分枝點處的注釋;//說明程序
s. 對各變量的功能、范圍、缺省條件等所加的注釋;
t. 對使用的邏輯所加的注釋等等。
7.10限制條件
(1)由於本系統的開發將是基於Window的C/S 結構,所以客戶端的語言使用Win form,服務器端的語言使用WCF,開發人員將不能用其他的開發語言(編寫組件除外)。而數據庫也將隨之采用SQL Server2012。
(2)開發人員在編寫代碼的過程中需要嚴格按照軟件工程的要求來進行,以利於接下來的測試和維護及升級。
7.11測試計划
......
8BIM模型模塊 [模型屬性分類]設計說明
8.1程序描述
主要是模型屬性的信息進行分類.進行對分類添加,刪除,編輯的管理
可以正對不同的行業性。如果隧道,橋梁信息
8.2功能
說明該程序應具有的功能,可采用IPO圖:
8.3性能
靈活性:窗口響應絕大部分的快捷菜單和控制面板操作
時間特性:響應鼠標單擊的時間在2—3秒之間
8.4輸人項
輸入的數據是用戶執行的各種操作,包括鼠標、鍵盤等操作。。
8.5輸出項
輸出是從數據庫中讀取的數據,或錯誤警告信息。
8.6算法
本部分沒有采用自定義的算法。
8.7接口
硬件接口:主要就是WCF 以TCP/IP層中的網絡接口層
軟件接口:具體來說開發中可能使用到的ADO的常用對象有以下幾個:
(1)連接對象(Connection):用來連接數據庫。
(2)記錄集對象(RecordSet):用來保存查詢語句的返回結果。
(3)命令對象(Command):用來執行SQL語句或者SQL Server的存儲過程。
(4)參數對象(Parameter):用來為存儲過程或查詢提供參數。
8.8存儲分配
本程序在高級語言C#進行編碼,直接的內存分配由C#運行時分配。
8.9注釋設計
說明准備在本程序中安排的注釋,
u. 加在模塊首部的注釋;//簡介:開發人員: 時間
v. 加在各分枝點處的注釋;//說明程序
w. 對各變量的功能、范圍、缺省條件等所加的注釋;
x. 對使用的邏輯所加的注釋等等。
8.10限制條件
(1)由於本系統的開發將是基於Window的C/S 結構,所以客戶端的語言使用Win form,服務器端的語言使用WCF,開發人員將不能用其他的開發語言(編寫組件除外)。而數據庫也將隨之采用SQL Server2012。
(2)開發人員在編寫代碼的過程中需要嚴格按照軟件工程的要求來進行,以利於接下來的測試和維護及升級。
8.11測試計划
......
9BIM模型模塊[模型屬性模板]設計說明
9.1程序描述
主要是根據模型屬性的分類,根據分類添加對應的模板信息。
9.2功能
說明該程序應具有的功能,可采用IPO圖:
9.3性能
靈活性:窗口響應絕大部分的快捷菜單和控制面板操作
時間特性:響應鼠標單擊的時間在2—3秒之間
9.4輸人項
輸入的數據是用戶執行的各種操作,包括鼠標、鍵盤等操作。。
9.5輸出項
輸出是從數據庫中讀取的數據,或錯誤警告信息。
9.6算法
本部分沒有采用自定義的算法。
9.7接口
硬件接口:主要就是WCF 以TCP/IP層中的網絡接口層
軟件接口:具體來說開發中可能使用到的ADO的常用對象有以下幾個:
(1)連接對象(Connection):用來連接數據庫。
(2)記錄集對象(RecordSet):用來保存查詢語句的返回結果。
(3)命令對象(Command):用來執行SQL語句或者SQL Server的存儲過程。
(4)參數對象(Parameter):用來為存儲過程或查詢提供參數。
9.8存儲分配
本程序在高級語言C#進行編碼,直接的內存分配由C#運行時分配。
9.10限制條件
(1)由於本系統的開發將是基於Window的C/S 結構,所以客戶端的語言使用Win form,服務器端的語言使用WCF,開發人員將不能用其他的開發語言(編寫組件除外)。而數據庫也將隨之采用SQL Server2012。
(2)開發人員在編寫代碼的過程中需要嚴格按照軟件工程的要求來進行,以利於接下來的測試和維護及升級。
9.11測試計划
......
10 BIM模型模塊[模型屬性自定義模板]設計說明
10.1程序描述
主要是對應的分類加載分類對應的模板信息。
10.2功能
說明該程序應具有的功能,可采用IPO圖:
10.3性能
靈活性:窗口響應絕大部分的快捷菜單和控制面板操作
時間特性:響應鼠標單擊的時間在2—3秒之間
10.4輸人項
輸入的數據是用戶執行的各種操作,包括鼠標、鍵盤等操作。。
10.5輸出項
輸出是從數據庫中讀取的數據,或錯誤警告信息。
10.6算法
本部分沒有采用自定義的算法。
10.7接口
硬件接口:主要就是WCF 以TCP/IP層中的網絡接口層
軟件接口:具體來說開發中可能使用到的ADO的常用對象有以下幾個:
(1)連接對象(Connection):用來連接數據庫。
(2)記錄集對象(RecordSet):用來保存查詢語句的返回結果。
(3)命令對象(Command):用來執行SQL語句或者SQL Server的存儲過程。
(4)參數對象(Parameter):用來為存儲過程或查詢提供參數。
10.8存儲分配
本程序在高級語言C#進行編碼,直接的內存分配由C#運行時分配。
10.9注釋設計
說明准備在本程序中安排的注釋,
cc. 加在模塊首部的注釋;//簡介:開發人員: 時間
dd. 加在各分枝點處的注釋;//說明程序
ee. 對各變量的功能、范圍、缺省條件等所加的注釋;
ff. 對使用的邏輯所加的注釋等等。
10.10限制條件
(1)由於本系統的開發將是基於Window的C/S 結構,所以客戶端的語言使用Win form,服務器端的語言使用WCF,開發人員將不能用其他的開發語言(編寫組件除外)。而數據庫也將隨之采用SQL Server2012。
(2)開發人員在編寫代碼的過程中需要嚴格按照軟件工程的要求來進行,以利於接下來的測試和維護及升級。
10.11測試計划
......
11BIM模型模塊 [模型管理]設計說明
11.1程序描述
主要是對模型的信息添加,刪除,修改 等。
11.2功能
說明該程序應具有的功能,可采用IPO圖:
11.3性能
靈活性:窗口響應絕大部分的快捷菜單和控制面板操作
時間特性:響應鼠標單擊的時間在2—3秒之間
11.4輸人項
輸入的數據是用戶執行的各種操作,包括鼠標、鍵盤等操作。。
11.5輸出項
輸出是從數據庫中讀取的數據,或錯誤警告信息。
11.6算法
本部分沒有采用自定義的算法。
11.7接口
硬件接口:主要就是WCF 以TCP/IP層中的網絡接口層
軟件接口:具體來說開發中可能使用到的ADO的常用對象有以下幾個:
(1)連接對象(Connection):用來連接數據庫。
(2)記錄集對象(RecordSet):用來保存查詢語句的返回結果。
(3)命令對象(Command):用來執行SQL語句或者SQL Server的存儲過程。
(4)參數對象(Parameter):用來為存儲過程或查詢提供參數。
11.8存儲分配
本程序在高級語言C#進行編碼,直接的內存分配由C#運行時分配。
11.9注釋設計
說明准備在本程序中安排的注釋,
gg. 加在模塊首部的注釋;//簡介:開發人員: 時間
hh. 加在各分枝點處的注釋;//說明程序
ii. 對各變量的功能、范圍、缺省條件等所加的注釋;
jj. 對使用的邏輯所加的注釋等等。
11.10限制條件
(1)由於本系統的開發將是基於Window的C/S 結構,所以客戶端的語言使用Win form,服務器端的語言使用WCF,開發人員將不能用其他的開發語言(編寫組件除外)。而數據庫也將隨之采用SQL Server2012。
(2)開發人員在編寫代碼的過程中需要嚴格按照軟件工程的要求來進行,以利於接下來的測試和維護及升級。
11.11測試計划
......
12施工計划 設計說明
12.1程序描述
主要是考慮到集團類型的公司下一般都有很多分公司。管理員通過機構管理可以添加對應的機構信息。可以新增,編輯,刪除 等功能
12.2功能
說明該程序應具有的功能,可采用IPO圖:
12.3性能
靈活性:窗口響應絕大部分的快捷菜單和控制面板操作
時間特性:響應鼠標單擊的時間在2—3秒之間
12.4輸人項
輸入的數據是用戶執行的各種操作,包括鼠標、鍵盤等操作。。
12.5輸出項
輸出是從數據庫中讀取的數據,或錯誤警告信息。
12.6算法
本部分沒有采用自定義的算法。
12.7接口
硬件接口:主要就是WCF 以TCP/IP層中的網絡接口層
軟件接口:具體來說開發中可能使用到的ADO的常用對象有以下幾個:
(1)連接對象(Connection):用來連接數據庫。
(2)記錄集對象(RecordSet):用來保存查詢語句的返回結果。
(3)命令對象(Command):用來執行SQL語句或者SQL Server的存儲過程。
(4)參數對象(Parameter):用來為存儲過程或查詢提供參數。
12.8存儲分配
本程序在高級語言C#進行編碼,直接的內存分配由C#運行時分配。
12.9注釋設計
說明准備在本程序中安排的注釋,
kk. 加在模塊首部的注釋;//簡介:開發人員: 時間
ll. 加在各分枝點處的注釋;//說明程序
mm. 對各變量的功能、范圍、缺省條件等所加的注釋;
nn. 對使用的邏輯所加的注釋等等。
12.10限制條件
(1)由於本系統的開發將是基於Window的C/S 結構,所以客戶端的語言使用Win form,服務器端的語言使用WCF,開發人員將不能用其他的開發語言(編寫組件除外)。而數據庫也將隨之采用SQL Server2012。
(2)開發人員在編寫代碼的過程中需要嚴格按照軟件工程的要求來進行,以利於接下來的測試和維護及升級。
12.11測試計划
......
13施工日志設計說明
12.1程序描述
主要是考慮到集團類型的公司下一般都有很多分公司。管理員通過機構管理可以添加對應的機構信息。可以新增,編輯,刪除 等功能
12.2功能
說明該程序應具有的功能,可采用IPO圖:
12.3性能
靈活性:窗口響應絕大部分的快捷菜單和控制面板操作
時間特性:響應鼠標單擊的時間在2—3秒之間
12.4輸人項
輸入的數據是用戶執行的各種操作,包括鼠標、鍵盤等操作。。
12.5輸出項
輸出是從數據庫中讀取的數據,或錯誤警告信息。
12.6算法
本部分沒有采用自定義的算法。
12.7接口
硬件接口:主要就是WCF 以TCP/IP層中的網絡接口層
軟件接口:具體來說開發中可能使用到的ADO的常用對象有以下幾個:
(1)連接對象(Connection):用來連接數據庫。
(2)記錄集對象(RecordSet):用來保存查詢語句的返回結果。
(3)命令對象(Command):用來執行SQL語句或者SQL Server的存儲過程。
(4)參數對象(Parameter):用來為存儲過程或查詢提供參數。
12.8存儲分配
本程序在高級語言C#進行編碼,直接的內存分配由C#運行時分配。
12.10限制條件
(1)由於本系統的開發將是基於Window的C/S 結構,客戶端的語言使用Winform,服務器端的語言使用WCF,開發人員將不能用其他的開發語言(編寫組件除外)。而數據庫也將隨之采用SQL Server2012。
(2)開發人員在編寫代碼的過程中需要嚴格按照軟件工程的要求來進行,以利於接下來的測試和維護及升級。