寫(xiě)一份全面的“產(chǎn)品詳細設計說(shuō)明書(shū)”,具體應該是怎樣的?
這個(gè)主要看所設計的是哪一類(lèi)產(chǎn)品了。
對設計說(shuō)明撰寫(xiě)的看法是用最簡(jiǎn)短的手法來(lái)對設計作品進(jìn)行描述,
描術(shù)內容包括:創(chuàng )意來(lái)源、產(chǎn)品特點(diǎn)、加工工藝等等。
對象××產(chǎn)品設計說(shuō)明書(shū)
1 概述
1.1 產(chǎn)品簡(jiǎn)述
對產(chǎn)品要完成什么,所面向的用戶(hù)以及產(chǎn)品運行的環(huán)境的簡(jiǎn)短描述,這部分主要來(lái)源于需求說(shuō)明書(shū)的開(kāi)始部分。
1.2 產(chǎn)品設計目標
這部分論述整個(gè)產(chǎn)品的設計目標,明確地說(shuō)明哪些功能是產(chǎn)品決定實(shí)現而哪些時(shí)不準備實(shí)現的。同時(shí),對于非功能性的需求例如性能、可用性等,亦需提及。需求規格說(shuō)明書(shū)對于這部分的內容來(lái)說(shuō)是很重要的參考,看看其中明確了的功能性以及非功能性的需求。
這部分必須說(shuō)清楚設計的全貌如何,務(wù)必使讀者看后知道將實(shí)現的產(chǎn)品有什么特點(diǎn)和功能。在隨后的文檔部分,將解釋設計是怎么來(lái)實(shí)現這些的。
1.3 參考資料
列出本文檔中所引用的參考資料。(至少要引用需求規格說(shuō)明書(shū))
1.4 修訂版本記錄
列出本文檔修改的歷史紀錄。必須指明修改的內容、日期以及修改人。
2 術(shù)語(yǔ)表
對本文檔中所使用的各種術(shù)語(yǔ)進(jìn)行說(shuō)明。如果一些術(shù)語(yǔ)在需求規格說(shuō)明書(shū)中已經(jīng)說(shuō)明過(guò)了,此處不用再重復,可以指引讀者參考需求說(shuō)明。
3 用例
此處要求產(chǎn)品用用例圖表述(UML),對每個(gè)用例(正常處理的情況)要有中文敘述。
4 設計概述
4.1 簡(jiǎn)述
這部分要求突出整個(gè)設計所采用的方法(是面向對象設計還是結構化設計)、系統的體系結構(例如客戶(hù)/服務(wù)器結構)以及使用到的相應技術(shù)和工具(例如OMT、Rose)
4.2 產(chǎn)品結構設計
這部分要求提供高層產(chǎn)品結構的描述,使用方框圖來(lái)顯示主要的組件及組件間的交互。最好是把邏輯結構同物理結構分離,對前者進(jìn)行描述琺別忘了說(shuō)明圖中用到的俗語(yǔ)和符號。
4.2.1 頂層產(chǎn)品結構
4.2.2 子產(chǎn)品1結構
4.2.3 子產(chǎn)品2結構
4.3 產(chǎn)品界面
各種提供給用戶(hù)的界面以及外部產(chǎn)品在此處要予以說(shuō)明。如果在需求規格說(shuō)明書(shū)中已經(jīng)對用戶(hù)界面有了敘述,此處不用再重復,可以指引讀者參考需求說(shuō)明。如果產(chǎn)品提供了對其它產(chǎn)品的接口,必須在此說(shuō)明。