軟件產(chǎn)品設計項目說明指導書

{項目名稱}軟件產(chǎn)品設計闡明書文獻狀態(tài)：[√]草稿[]正式發(fā)布[]正在修改文獻標記：Company-Project-PIM-PROPOSAL當前版本：X.Y作者：完畢日期：Year-Month-Day北京捷諾視訊數(shù)碼科技有限公司BeijingGeneralDVRScience&TechnologyCo.Ltd二零一零年五月版本歷史版本/狀態(tài)作者參加者起止日期備注

目錄TOC\o"1-3"\h\z目錄 3一、 簡介 5二、 體系構造設計 52.1、 目 52.2、 角色與職責 62.3、 啟動準則 62.4、 輸入 62.5、 重要環(huán)節(jié) 62.5.1、 設計準備 62.5.2、 擬定影響系統(tǒng)設計約束因素 62.5.3、 擬定設計方略 72.5.4、 系統(tǒng)分解與設計 72.5.5、 撰寫體系構造設計文檔 72.5.6、 體系構造設計評審 72.5.7、 [后續(xù)活動] 82.6、 輸出 82.7、 結束準則 82.8、 度量 8三、 顧客界面設計 83.1、 目 83.2、 角色與職責 83.3、 啟動準則 83.4、 輸入 93.5、 重要環(huán)節(jié) 93.5.1、 設計準備 93.5.2、 顧客界面設計 93.5.3、 撰寫顧客界面設計文檔 103.5.4、 顧客界面設計評審 103.5.5、 [后續(xù)活動] 103.6、 輸出 113.7、 結束準則 113.8、 度量 11四、 數(shù)據(jù)庫設計 114.1、 目 114.2、 角色與職責 114.3、 啟動準則 114.4、 輸入 114.5、 重要環(huán)節(jié) 124.5.1、 設計準備 124.5.2、 數(shù)據(jù)庫設計 124.5.3、 撰寫數(shù)據(jù)庫設計文檔 134.5.4、 數(shù)據(jù)庫設計評審 144.5.5、 [后續(xù)活動] 144.6、 輸出 144.7、 結束準則 144.8、 度量 14五、 模塊設計 145.1、 目 145.2、 角色與職責 145.3、 啟動準則 155.4、 輸入 155.5、 重要環(huán)節(jié) 155.5.1、 設計準備 155.5.2、 模塊設計 155.5.3、 撰寫模塊設計文檔 165.5.4、 模塊設計評審 165.5.5、 [后續(xù)活動] 165.6、 輸出 165.7、 結束準則 165.8、 度量 17六、 實行建議 17

設計簡介系統(tǒng)設計（SystemDesign，SD）是指設計軟件系統(tǒng)體系構造、顧客界面、數(shù)據(jù)庫、模塊等，從而在需求與代碼之間建立橋梁，指引開發(fā)人員去實現(xiàn)能滿足顧客需求軟件產(chǎn)品。系統(tǒng)設計過程域是CMM模型重要構成某些。本規(guī)范闡述了系統(tǒng)設計過程域四個重要規(guī)程：體系構造設計顧客界面設計數(shù)據(jù)庫設計模塊設計上述每個規(guī)程“目的”、“角色與職責”、“啟動準則”、“輸入”、“重要環(huán)節(jié)”、“輸出”、“完畢準則”和“度量”均已定義。系統(tǒng)設計過程域分為兩個階段：高層設計階段和詳細設計階段。高層設計階段重點是軟件系統(tǒng)體系構造設計。詳細設計階段重點是顧客界面設計、數(shù)據(jù)庫設計和模塊設計，如圖所示。需求開發(fā)高層設計階段體系構造設計數(shù)據(jù)庫設計顧客界面設計模塊設計實現(xiàn)與測試詳細設計階段需求開發(fā)高層設計階段體系構造設計數(shù)據(jù)庫設計顧客界面設計模塊設計實現(xiàn)與測試詳細設計階段系統(tǒng)設計過程域示意圖系統(tǒng)設計過程域產(chǎn)生重要文檔有：《體系構造設計報告》?！额櫩徒缑嬖O計報告》。《數(shù)據(jù)庫設計報告》。《模塊設計報告》。體系構造設計目分析與設計軟件體系構造。通過系統(tǒng)分解，擬定子系統(tǒng)功能和子系統(tǒng)之間關系，以及模塊功能和模塊之間關系，產(chǎn)生《體系構造設計報告》。角色與職責項目經(jīng)理指定若干名開發(fā)人員從事體系構造設計（如下稱為體系構造設計人員）。啟動準則體系構造設計人員已經(jīng)擬定。輸入需求文檔如《產(chǎn)品需求規(guī)格闡明書》重要環(huán)節(jié) 體系構造設計流程如圖所示。Step3.擬定設計方略Step2.擬定約束因素Step1.設計準備Step3.擬定設計方略Step2.擬定約束因素Step1.設計準備Step4.系統(tǒng)分解設計Step6.設計評審Step5.撰寫文檔體系構造設計流程設計準備項目經(jīng)理或者技術負責人分派系統(tǒng)設計任務，涉及體系構造設計、模塊設計、顧客界面設計、數(shù)據(jù)庫設計等。本活動也許產(chǎn)生一份階段性開發(fā)籌劃，如《系統(tǒng)設計籌劃》，視工作量而定。體系構造設計人員閱讀需求文檔，明確設計任務。體系構造設計人員準備有關設計工具（如RationalRose）和資料。擬定影響系統(tǒng)設計約束因素需求約束。體系構造設計人員從需求文檔如《軟件需求規(guī)格闡明書》中提取需求約束，例如：本系統(tǒng)應當遵循原則或規(guī)范軟件、硬件環(huán)境（涉及運營環(huán)境和開發(fā)環(huán)境）約束接口/合同約束顧客界面約束軟件質量約束，如對的性、健壯性、可靠性、效率（性能）、易用性、清晰性、安全性、可擴展性、兼容性、可移植性等等。隱含約束。有某些假設或依賴并沒有在需求文檔中明確指出，但也許會對系統(tǒng)設計產(chǎn)生影響，設計人員應當盡量地在此處闡明。例如對顧客教誨限度、計算機技能某些假設或依賴，對支撐本系統(tǒng)軟件硬件假設或依賴等。擬定設計方略體系構造設計人員依照產(chǎn)品需求與發(fā)展戰(zhàn)略，擬定設計方略（DesignStrategy）。例如：擴展方略。闡明為了以便本系統(tǒng)在將來擴展功能，當前有什么辦法。復用方略。闡明本系統(tǒng)在當前以及將來復用方略。折衷方略。闡明當兩個目的難以同步優(yōu)化時如何折衷，例如“時－空”效率折衷，復雜性與實用性折衷。系統(tǒng)分解與設計體系構造設計人員：將系統(tǒng)分解為若干子系統(tǒng)，擬定每個子系統(tǒng)功能以及子系統(tǒng)之間關系。將子系統(tǒng)分解為若干模塊，擬定每個模塊功能以及模塊之間關系。擬定系統(tǒng)開發(fā)、測試、運營所需軟硬件環(huán)境。撰寫體系構造設計文檔體系構造設計人員依照指定模板撰寫《體系構造設計報告》，重要內(nèi)容涉及：軟件系統(tǒng)概述影響設計約束因素設計方略系統(tǒng)總體構造子系統(tǒng)構造與模塊功能開發(fā)、測試、運營所需軟硬件環(huán)境體系構造設計評審體系構造設計人員邀請同行專家、開發(fā)人員對體系構造進行正式技術評審。體系構造評審重點不是“對還是錯”，而是“好還是差”。重要評審要素涉及：適當性?？疾煸擉w系構造與否適合于產(chǎn)品需求，與否可在預定籌劃內(nèi)實現(xiàn)。系統(tǒng)綜合能力（Capability）。例如“時－空”效率（性能，容量等），可擴展性，可管理性（可維護性），可復用性，安全性等等，視產(chǎn)品特性而定。[后續(xù)活動]體系構造設計完畢后進入詳細設計階段（顧客界面設計、數(shù)據(jù)庫設計、模塊設計等）。輸出《體系構造設計報告》結束準則《體系構造設計報告》已經(jīng)完畢，并且通過了技術評審。度量體系構造設計人員記錄工作量以及文檔規(guī)模，報告給項目經(jīng)理。顧客界面設計目設計軟件顧客界面，產(chǎn)生《顧客界面設計報告》。制作顧客界面資源如圖像、圖標或者界面專用組件等。角色與職責項目經(jīng)理指定若干名開發(fā)人員從事顧客界面設計（如下稱為界面設計人員）。如果也許話，邀請顧客或美工人員協(xié)助設計顧客界面。啟動準則需求文檔已經(jīng)完畢。體系構造設計已經(jīng)完畢。輸入需求文檔體系構造設計文檔重要環(huán)節(jié) 顧客界面設計流程如圖所示。迭代Step2.界面設計Step4.設計評審Step3.撰寫文檔Step1.設計準備2.3細化2.2原型評估2.1原型創(chuàng)作迭代Step2.界面設計Step4.設計評審Step3.撰寫文檔Step1.設計準備2.3細化2.2原型評估2.1原型創(chuàng)作體系構造設計流程設計準備界面設計人員閱讀需求文檔和體系構造設計文檔，明確界面設計任務。界面設計人員與顧客交流，理解顧客工作習慣和她們對界面看法。界面設計人員準備有關設計工具和資料，收集或創(chuàng)作基本界面資源如圖像、圖標以及通用組件。界面設計人員擬定本軟件顧客界面設計規(guī)則（或指南），重要涉及：先進界面特性或通用設計原則；軟件主界面（如主窗口、主頁面）設計規(guī)則；軟件子界面（如子窗口、子頁面）設計規(guī)則；原則控件使用規(guī)則；美學設計規(guī)則。顧客界面設計顧客界面設計普通要經(jīng)歷“原型創(chuàng)作—>原型評估－>細化”等環(huán)節(jié)，普通迭代進行。[Step2.1]原型創(chuàng)作界面設計人員創(chuàng)作界面原型：先徒手畫，或者用Visio等工具繪制界面視圖；再用軟件開發(fā)工具實現(xiàn)可以運營原型。[Step2.2]原型評估界面設計人員邀請顧客和同行們評估界面原型，匯集意見，及時改進。[Step2.3]細化界面設計人員細化界面原型，例如美工解決，添加細節(jié)等。補充闡明：開發(fā)人員在本階段不必關懷界面原型代碼質量，由于界面原型也許不斷地被修改甚至被拋棄。撰寫顧客界面設計文檔顧客界面定型之后，界面設計人員依照指定模板撰寫《顧客界面設計報告》，重要內(nèi)容涉及：應當遵循界面設計規(guī)范；界面關系圖和工作流程圖；主界面視圖、功能闡明、操作方式；子界面視圖、功能闡明、操作方式；美學設計闡明。顧客界面設計評審界面設計人員邀請顧客和同行們對定型后界面進行正式技術評審，盡最大努力使界面變得更加美觀、易用。顧客界面重要評審要素涉及：適當性簡潔易用一致性美觀動態(tài)反饋功能屏蔽和出錯解決顧客控制國際化（兼容性和可移植性）適應性（針對各種顧客）[后續(xù)活動]在系統(tǒng)設計工作結束之后，開發(fā)人員編寫界面代碼，并和顧客一起通過各種途徑測試界面，從而不斷地完善顧客界面。（請參照關于測試文檔）界面設計人員總結經(jīng)驗教訓，不斷地完善合用于本機構“顧客界面設計指南”。輸出《顧客界面設計報告》結束準則《顧客界面設計報告》已經(jīng)完畢，界面原型已經(jīng)通過評審。度量界面設計人員記錄工作量以及文檔規(guī)模，報告給項目經(jīng)理。數(shù)據(jù)庫設計目設計軟件數(shù)據(jù)庫，產(chǎn)生《數(shù)據(jù)庫設計報告》。角色與職責項目經(jīng)理指定若干名開發(fā)人員從事數(shù)據(jù)庫設計（如下稱為數(shù)據(jù)庫設計人員）。啟動準則需求文檔已經(jīng)完畢。體系構造設計已經(jīng)完畢。輸入需求文檔體系構造設計文檔重要環(huán)節(jié) 數(shù)據(jù)庫設計流程如圖所示。迭代Step2.數(shù)據(jù)庫設計Step3.撰寫文檔2.4優(yōu)化2.3安全性設計2.2物理設計2.1邏輯設計Step1.設計準備Step4.設計評審迭代Step2.數(shù)據(jù)庫設計Step3.撰寫文檔2.4優(yōu)化2.3安全性設計2.2物理設計2.1邏輯設計Step1.設計準備Step4.設計評審數(shù)據(jù)庫設計流程設計準備數(shù)據(jù)庫設計人員閱讀需求文檔和體系構造設計文檔，明確數(shù)據(jù)庫設計任務。數(shù)據(jù)庫設計人員準備有關設計工具和資料。數(shù)據(jù)庫設計人員擬定本軟件數(shù)據(jù)庫設計規(guī)則（或指南），重要涉及：數(shù)據(jù)庫命名規(guī)則邏輯設計規(guī)則（或指南）物理設計規(guī)則（或指南）安全性設計規(guī)則（或指南）優(yōu)化規(guī)則（或指南）數(shù)據(jù)庫管理與維護規(guī)則（或指南）數(shù)據(jù)庫設計 數(shù)據(jù)庫設計普通要經(jīng)歷“邏輯設計—>物理設計－>安全性設計－>優(yōu)化”等環(huán)節(jié)，普通要迭代進行。邏輯設計數(shù)據(jù)庫設計人員依照需求文檔，創(chuàng)立與數(shù)據(jù)庫有關那某些實體關系圖（ERD）。如果采用面向對象辦法（OOAD），這里實體相稱于類（class）。物理設計設計表構造。普通地，實體相應于表，實體屬性相應于表列，實體之間關系成為表約束。邏輯設計中實體大某些可以轉換成物理設計中表，但是它們并不一定是一一相應。數(shù)據(jù)庫表參照格式如表11-1所示。對表構造進行規(guī)范化解決（第三范式）。表名功能闡明列名數(shù)據(jù)類型（精度范疇）空/非空約束條件補充闡明數(shù)據(jù)庫表參照格式安全性設計提高軟件系統(tǒng)安全性應當從“管理”和“設計”兩方面著手。這里僅考慮數(shù)據(jù)庫安全性設計。顧客只能用帳號登陸到應用軟件，通過應用軟件訪問數(shù)據(jù)庫，而沒有其他途徑可以操作數(shù)據(jù)庫。對顧客帳號密碼進行加密解決，保證在任何地方都不會浮現(xiàn)密碼明文。擬定每個角色對數(shù)據(jù)庫表操作權限，如創(chuàng)立、檢索、更新、刪除等。每個角色擁有剛好可以完畢任務權限，不多也不少。在應用時再為顧客分派角色，則每個顧客權限等于她所兼角色權限之和。優(yōu)化分析并優(yōu)化數(shù)據(jù)庫“時－空”效率，盡量地“提高解決速度”并且“減少數(shù)據(jù)占用空間”。分析“時－空”效率瓶頸，找出優(yōu)化對象（目的），并擬定優(yōu)先級。當優(yōu)化對象（目的）之間存在對抗時，給出折衷方案。給出優(yōu)化詳細辦法，例如優(yōu)化數(shù)據(jù)庫環(huán)境參數(shù)，對表格進行反規(guī)范化解決等。撰寫數(shù)據(jù)庫設計文檔數(shù)據(jù)庫設計人員依照指定模板撰寫《數(shù)據(jù)庫設計報告》，重要內(nèi)容涉及：數(shù)據(jù)庫環(huán)境闡明數(shù)據(jù)庫命名規(guī)則邏輯設計物理設計安全性設計優(yōu)化數(shù)據(jù)庫管理與維護闡明數(shù)據(jù)庫設計評審數(shù)據(jù)庫設計人員邀請同行們對數(shù)據(jù)庫進行正式技術評審。數(shù)據(jù)庫重要評審要素涉及：對的性、完整性、一致性安全性“時－空”效率[后續(xù)活動]在系統(tǒng)設計工作結束之后，開發(fā)人員將編寫與數(shù)據(jù)庫有關代碼，并和顧客一起通過各種途徑測試數(shù)據(jù)庫，從而不斷地完善數(shù)據(jù)庫。（請參照關于測試文檔）數(shù)據(jù)庫設計人員總結經(jīng)驗教訓，不斷地完善合用于本機構《數(shù)據(jù)庫設計指南》。軟件交付給顧客后，由顧客管理與維護數(shù)據(jù)庫。輸出《數(shù)據(jù)庫設計報告》結束準則《數(shù)據(jù)庫設計報告》已經(jīng)完畢，并且通過了技術評審。度量數(shù)據(jù)庫設計人員記錄工作量以及文檔規(guī)模，報告給項目經(jīng)理。模塊設計目設計軟件所有模塊重要接口與屬性、數(shù)據(jù)構造和算法，產(chǎn)生《模塊設計報告》。角色與職責項目經(jīng)理指定若干名開發(fā)人員從事模塊設計（如下稱為模塊設計人員），模塊設計人員將在實現(xiàn)階段編寫這些模塊代碼。啟動準則需求文檔已經(jīng)完畢。體系構造設計已經(jīng)完畢。輸入需求文檔體系構造設計文檔重要環(huán)節(jié) 模塊設計流程如圖所示。Step2.模塊設計2.1接口與屬性設計Step4.設計評審Step3.撰寫文檔Step1.設計準備迭代2.2數(shù)據(jù)構造Step2.模塊設計2.1接口與屬性設計Step4.設計評審Step3.撰寫文檔Step1.設計準備迭代2.2數(shù)據(jù)構造與算法設計模塊設計流程設計準備模塊設計人員閱讀需求文檔和體系構造設計文檔，明確模塊設計任務。模塊設計人員準備有關設計工具和資料。模塊設計人員擬定本軟件編程規(guī)范，保證模塊設計文檔風格與代碼風格保持一致。模塊設計 模塊設計普通要經(jīng)歷“接口與屬性設計—>數(shù)據(jù)構造與算法設計”等環(huán)節(jié)，并且普通需要重復迭代。建議：由于當代軟件開發(fā)工具越來越先進，模塊詳細設計和編程可以較好地融合一起，并且效率相稱高，有些工具甚至具備代碼自動生成功能。因此在系統(tǒng)設計階段