1樓:匿名使用者
物件導向軟體設計說明書模板
1 概述
1.1 系統簡述
對系統要完成什麼,所面向的使用者以及系統執行的環境的簡短描述,這部分主要**於需求說明書的開始部分。
1.2 軟體設計目標
這部分論述整個系統的設計目標,明確地說明哪些功能是系統決定實現而哪些時不準備實現的。同時,對於非功能性的需求例如效能、可用性等,亦需提及。需求規格說明書對於這部分的內容來說是很重要的參考,看看其中明確了的功能性以及非功能性的需求。
這部分必須說清楚設計的全貌如何,務必使讀者看後知道將實現的系統有什麼特點和功能。在隨後的文件部分,將解釋設計是怎麼來實現這些的。
1.3 參考資料
列出本文件中所引用的參考資料。(至少要引用需求規格說明書)
1.4 修訂版本記錄
列出本文件修改的歷史紀錄。必須指明修改的內容、日期以及修改人。
2 術語表
對本文件中所使用的各種術語進行說明。如果一些術語在需求規格說明書中已經說明過了,此處不用再重複,可以指引讀者參考需求說明。
3 用例
此處要求系統用用例圖表述(uml),對每個用例(正常處理的情況)要有中文敘述。
4 設計概述
4.1 簡述
這部分要求突出整個設計所採用的方法(是物件導向設計還是結構化設計)、系統的體系結構(例如客戶/伺服器結構)以及使用到的相應技術和工具(例如omt、rose)
4.2 系統結構設計
這部分要求提供高層系統結構的描述,使用方框圖來顯示主要的元件及元件間的互動。最好是把邏輯結構同物理結構分離,對前者進行描述。別忘了說明圖中用到的俗語和符號。
4.2.1 頂層系統結構
4.2.2 子系統1結構
4.2.3 子系統2結構
4.3 系統介面
各種提供給使用者的介面以及外部系統在此處要予以說明。如果在需求規格說明書中已經對使用者介面有了敘述,此處不用再重複,可以指引讀者參考需求說明。如果系統提供了對其它系統的介面,比如說從其它軟體系統匯入/匯出資料,必須在此說明。
4.4 約束和假定
描述系統設計中最主要的約束,這些是由客戶強制要求並在需求說明書寫明的。說明系統是如何來適應這些約束的。
另外如果本系統跟其它外部系統互動或者依賴其它外部系統提供一些功能輔助,那麼系統可能還受到其它的約束。這種情況下,要求清楚地描述與本系統有互動的軟體型別(比如某某某資料庫軟體,某某某email軟體)以及這樣導致的約束(比如只允許純文字的email)。
實現的語言和平台也會對系統有約束,同樣在此予以說明。
對於因選擇具體的設計實現而導致對系統的約束,簡要地描述你的想法思路,經過怎麼樣的權衡,為什麼要採取這樣的設計等等。
5 物件模型
5.1 系統物件模型
提供整個系統的物件模型,如果模型過大,按照可行的標準把它劃分成小塊,例如可以把客戶端和伺服器端的物件模型分開成兩個圖表述。
物件圖應該包含什麼呢?
在其中應該包含所有的系統物件。這些物件都是從理解需求後得到的。要明確哪些應該、哪些不應該被放進圖中。
所有物件之間的關聯必須被確定並且必須指明聯絡的基數(一對
一、一對多還是多對多,0..1,*,1..*)。聚合和繼承關係必須清楚地確定下來。每個圖必須附有簡單的說明。
可能經過多次反覆之後才能得到系統的正確的物件模型。
6 物件描述
在這個部分敘述每個物件的細節,它的屬性、它的方法。在這之前必須從邏輯上對物件進行組織。你可能需要用結構圖把物件按子系統劃分好。
為每個物件做乙個條目。在系統物件模型中簡要的描述它的用途、約束(如只能有乙個例項),列出它的屬性和方法。如果物件是儲存在持久的資料容器中,標明它是持久物件,否則說明它是個臨時物件(transient object)。
對每個物件的每個屬性詳細說明:名字、型別,如果屬性不是很直觀或者有約束(例如,每個物件的該屬性必須有乙個唯一的值或者值域是有限正整數等)。
對每個物件的每個方法詳細說明:方法名,返回型別,返回值,引數,用途以及使用的演算法的簡要說明(如果不是特別簡單的話)。如果對變數或者返回值由什麼假定的話,pre-conditions和post-conditions必須在此說明。
列出它或者被它呼叫的方法需要訪問或者修改的屬性。最後,提供可以驗證實現方法的測試案例。
6.1 子系統1中的物件
6.1.1 物件:物件1
用途:約束:
永續性:
6.1.1.1 屬性描述:
1. 屬性:屬性1
型別:描述:
約束:2. 屬性:屬性2
6.1.1.2 方法描述:
1. 方法:方法1
返回型別:
引數:返回值:
pre-condition:
post-condition:
讀取/修改的屬性:
呼叫的方法:
處理邏輯:
測試例:用什麼引數呼叫該方法,期望的輸出是什麼……
7 動態模型
這部分的作用是描述系統如何響應各種事件。例如,可以建立系統的行為模型。一般使用順序圖和狀態圖。
確定不同的場景(scenario)是第一步,不需要確定所有可能的場景,但是必須至少要覆蓋典型的系統用例。不要自己去想當然地創造場景,通常的策略是描述那些客戶可以感受得到的場景。
7.1 場景(scenarios)
對每個場景做一則條目,包括以下內容:
場景名:給它乙個可以望文生義的名字
場景描述:簡要敘述場景是幹什麼的以及發生的動作的順序。
順序圖:描述各種事件及事件發生的相對時間順序。
7.1.1 場景:場景1
描述:動作1動作27.2 狀態圖
這部分的內容包括系統動態模型重要的部分的狀態圖。可能你想為每個物件畫乙個狀態圖,但事實上會導致太多不期望的細節資訊,只需要確定系統中一些重要的物件並為之提供狀態圖即可。
7.2.1 狀態圖1:
8 非功能性需求
在這個部分,必須說明如何處理需求文件中指定的非功能性需求。盡可能客觀地評估系統應付每乙個非功能性的需求的能力程度。如果某些非功能性需求沒有完全在設計的系統中實現,請務必在此說明。
另外,你也需要對系統將來的進化作乙個估計並描述本設計如何使系統能夠適應這些可預見的變化。
9 輔助文件
提供能幫助理解設計的相應文件。
10 詞彙索引
文章錄入
2樓:百度文庫精選
內容來自使用者:鳳凰涅槃
軟體系統設計說明書 軟體功能設計說明書 軟體詳細設計說明書 簡單說一下,三者有什麼不一樣
3樓:哪天下雨
我們不這麼叫,你可以參考一下:
軟體任務書:軟體完成那些功能?具備哪些效能,以及交付條件、維護條件等,通常是提出方做的。
軟體需求說明書:為了完成上面的功能,如何設計,包括對任務書的理解,功能劃分、模組劃分等,關鍵的流程,也是給下一級軟體編寫人員的要求,軟體管理人員寫的;
軟體設計說明書:碼農自己寫的,為了測試、維護等等,看的人就不多了。
軟體工程中《軟體需求規格說明書》和《詳細設計說明書》區別。
4樓:洪鎧迪
需求規格說明書在前,詳細設計說明書在後.
需求規格說明書要界定使用者的最終需求,建立軟體的功能框架.
詳細設計說明書在概要設計的基礎上要深化設計,介面\內容都要具體化.
軟體開發詳細設計說明書中的功能設計怎麼寫?請詳述.
5樓:莫道丶
詳細設計就是把專案裡抄
每個功能點bai都要完完整整列出來。
du好比使用者注zhi冊:在xx頁面輸入使用者名稱、密dao碼、**、位址。
提交之後會返回什麼樣訊息。出錯會提示什麼情況。
最後還要加個流程圖。
而需求只需要寫明大概功能點要達到什麼要的目的就可以了。沒這麼細。
詳細設計說明書的說明書
6樓:惡少灬天降
1引言1.1編寫目的
bai說明du編寫這份詳zhi細設計說明書的目的dao,指出預期的讀者。版
1.2背景
a.待開發軟體
權系統的名稱;
b.本專案的任務提出者、開發者、使用者和執行該程式系統的計算中心。
1.3定義
列出本專案中用到專門術語的定義和外文首字母組詞的原片語。
詳細設計說明書的使用技巧
7樓:艾絲蒂爾
對詳細設計說明書的內容要求如下:
1 引言
1.1編寫目的
1.2背景
1.3定義
1.4參考資料版
2 程式權系統的組織結構
3 程式(識別符號)設計說明
3.1程式描述
3.2功能
3.3效能
3.4輸入項
3.5輸出項
3.6演算法
3.7流程邏輯
3.8介面
3.9儲存分配
3.10注釋設計
3.11限制條件
3.12測試計畫.
3.13尚未解決的問題
4 程式2(識別符號)設計說明
......
詳細設計說明書怎麼寫 5
8樓:ethx笑口常開
詳細設計,復這是考驗技術專家設計思維制的重要關卡,bai詳細設計說明du書應當把具體
zhi的模組以最』乾淨』的方式
dao(黑箱結構)提供給編碼者,使得系統整體模組化達到最大;乙份好的詳細設計說明書,可以使編碼的複雜性減低到最低,實際上,嚴格的講詳細設計說明書應當把每個函式的每個引數的定義都精精細細的提供出來,從需求分析到概要設計到完成詳細設計說明書,乙個軟體專案就應當說完成了一半了。換言之,乙個大型軟 件系統在完成了一半的時候,其實還沒有開始一行**工作。
概要設計說明書和總體設計說明書的區別
我的理解是,總體設計僅僅描述了產品的形態,如果是網路軟體,可以描述產品以其他子系統在網路中的部署方式 總體設計需要把產品所有可能出現的產品形態列出,這樣可以方便非技術人員 市場 客戶 了解這個產品的功能。概要設計則是針對乙個產品做出稍微詳細的分析,需求提供相關介面 模組劃分 資料儲存方式等。我也是最...
鑽床夾具設計說明書,鑽床夾具設計說明書,夾具零件圖,夾具裝配圖
雞取 設計焊接工裝時必須考慮實用性 經濟性 可靠性 藝術性等。在機械設計和製造過程中,普遍存在尺寸鏈問題。在把零件組裝成機器的過程中,也就是將零件上有關的尺寸進行組合和積累。由於零件尺寸存在製造誤差,因此裝配時也就會有誤差的綜合和積累。累積後形成的總誤差將會影響機器的工作效能和質量。這就形成了零件的...
機械設計說明書到底怎麼做,機械設計說明書到底怎麼做?
我也正在做機械設計!你最好找一本機械設計指導書,上面有很多設計指導,也有案例指導的!還有很多查表資料供你查表,祝你順利!機械設計說明書怎樣寫? 機械設計說明書具體需要的內容包括。1 標題。設計課題的名稱。要求描述清楚。2 任務書。應說明設計目的和任務要求。要求 扼要敘述本設計的主要內容 特點 引數效...