面向對象分析文檔模板

1、面向對象的軟件開發(fā)方法姓 名：張法晏班級名稱：智科2指導教師：劉衛(wèi)平實驗日期：2016/4/25日期版本描述作者<8/10/07><0.1><Write use case specification for the “Maintain Information” use case><方健宏>2016年4月- 10 -目 錄1. 概述- 3 -1.1 系統(tǒng)簡述- 3 -1.2 軟件設計目標- 3 -1.3 參考資料- 3 -2. 術語表- 4 -3. 用例- 4 -4. 設計概述（此處請用簡單的結構化描述）- 4 -4.1 簡述- 4 -4.2 系統(tǒng)

2、結構設計- 4 -4.3 系統(tǒng)界面- 5 -4.4 約束和假定- 5 -5. 對象模型- 5 -5.1 類定義- 5 -5.2 類關聯(lián)描述- 6 -5.3 對象模型圖- 6 -6. 對象數(shù)據(jù)字典描述- 6 -6.1 子系統(tǒng)1中的對象- 7 -7. 動態(tài)模型- 8 -7.1 場景（Scenarios）- 8 -7.2事件定義（Events）- 8 -7.3 狀態(tài)圖- 9 -8. 功能模型- 9 -8.1 確定輸入輸出與事件關系- 9 -8.2 功能模型圖- 9 -9. 數(shù)據(jù)庫定義- 9 -10. 部署圖- 9 -11. 非功能性需求- 9 -12. 輔助文檔- 10 -13. 詞匯索引- 10

3、-1. 概述1.1 系統(tǒng)簡述系統(tǒng)來源或者背景；系統(tǒng)要完成什么任務；所面向的用戶；系統(tǒng)運行的環(huán)境的簡短描述。這部分主要來源于需求說明書的開始部分。1.2 軟件設計目標這部分論述整個系統(tǒng)的設計目標，明確地說明要實現(xiàn)哪些功能。對非功能性的需求例如性能、可用性、安全性、可靠性、可移植性等，亦需提及。需求規(guī)格說明書對于這部分的內容來說是很重要的參考，看看其中明確了的功能性以及非功能性的需求。這部分必須說清楚設計的全貌如何，務必使讀者看后知道將實現(xiàn)的系統(tǒng)有什么特點和功能。在隨后的文檔部分，將解釋設計是怎么來實現(xiàn)這些功能的。1.3 參考資料列出本文檔中所引用的參考資料。（至少要引用需求規(guī)格說明書），格式如下

4、)：(序號 作者. 書籍或者論文名稱. 出版社或者期刊名稱, 出版年.月如果是期刊后面必須有起止頁碼，格式如下：1 董國林,劉鑫. 基于STC單片機的指紋考勤系統(tǒng)設計. 工業(yè)控制計算機,2012.11(25):110-1112 林.巴斯等. 軟件構架實踐. 清華大學出版社, 2003.8 2. 術語表對本文檔中所使用的各種專業(yè)術語、容易引起歧義的術語以及自定義的術語進行說明。如果一些術語在需求規(guī)格說明書中已經說明過了，此處不用再重復，可以指引讀者參考需求說明。3. 用例3.1 用例圖3.2 用例描述此處要求系統(tǒng)用用例圖表述（UML），對每個用例（正常處理的情況）要有中文敘述。用例中請將事件進行

5、標注。 用例序號（如：用例1）：用例名稱（如：年度學籍審查）對該用例進行一句或兩句簡短描述參與者（如：教學秘書）包含、擴展或泛化該用況所包含、可擴展的用例，以及包含或擴展它的用例；或者該用例的子用例或者父用例前置條件啟動此用況所必須具備的條件。后置條件在該用況結束時確保成立的條件。工作流描述該用況的細節(jié)。（基本流與可選流）例外在該用況的執(zhí)行的過程中可能引起的例外。限制在應用中可能出現(xiàn)的任何限制。注釋提供可能對該用況是重要的任何附加信息。其中工作流的描述如下模板：研究生啟動系統(tǒng)； 系統(tǒng)提示研究生輸入研究生證號和密碼；研究生輸入研究生證號和密碼； 系統(tǒng)進行驗證，給出驗證信息；若通過，若該生選擇選課

6、 系統(tǒng)在擴展點”選課”處執(zhí)行用況“選課”；若通過，若該生選擇查看學分 系統(tǒng)在擴展點”查看學分”處執(zhí)行用況“查看學分”4. 設計概述（此處請用簡單的結構化描述）4.1 簡述這部分要求突出整個設計所采用的方法（是面向對象設計還是結構化設計）、系統(tǒng)的體系結構（例如客戶/服務器結構）以及使用到的相應技術和工具（例如OMT、Rose）4.2 系統(tǒng)結構設計這部分要求提供高層系統(tǒng)結構的描述，使用方框圖來顯示主要的組件及組件間的交互。最好是把邏輯結構同物理結構分離，對前者進行描述。別忘了說明圖中用到的俗語和符號。4.2.1 頂層系統(tǒng)結構4.2.2 子系統(tǒng)1結構4.2.3 子系統(tǒng)2結構4.3 系統(tǒng)界面各種提供給

7、用戶的界面以及外部系統(tǒng)在此處要予以說明。如果在需求規(guī)格說明書中已經對用戶界面有了敘述，此處不用再重復，可以指引讀者參考需求說明。如果系統(tǒng)提供了對其它系統(tǒng)的接口，比如說從其它軟件系統(tǒng)導入/導出數(shù)據(jù)，必須在此說明。4.4 約束和假定描述系統(tǒng)設計中最主要的約束，這些是由客戶強制要求并在需求說明書寫明的。說明系統(tǒng)是如何來適應這些約束的。另外如果本系統(tǒng)跟其它外部系統(tǒng)交互或者依賴其它外部系統(tǒng)提供一些功能輔助，那么系統(tǒng)可能還受到其它的約束。這種情況下，要求清楚地描述與本系統(tǒng)有交互的軟件類型（比如某某某數(shù)據(jù)庫軟件，某某某EMail軟件）以及這樣導致的約束（比如只允許純文本的Email）。實現(xiàn)的語言和平臺也會對

8、系統(tǒng)有約束，同樣在此予以說明。對于因選擇具體的設計實現(xiàn)而導致對系統(tǒng)的約束，簡要地描述你的想法思路，經過怎么樣的權衡，為什么要采取這樣的設計等等。5. 對象模型5.1 類定義提供整個系統(tǒng)的對象模型，如果模型過大，按照可行的標準把它劃分成小，例如可以把客戶端和服務器端的對象模型分開成兩個圖表述。對象圖應該包含什么呢？在其中應該包含所有的系統(tǒng)對象。這些對象都是從理解需求后得到的。要明確哪些應該、哪些不應該被放進圖中。所有對象之間的關聯(lián)必須被確定并且必須指明聯(lián)系的基數(shù)（一對一、一對多還是多對多，0.1，*，1.*）。聚合和繼承關系必須清楚地確定下來。每個圖必須附有簡單的說明?？赡芙涍^多次反復之后才能得

9、到系統(tǒng)的正確的對象模型。5.2 類關聯(lián)描述請文字描述類關聯(lián)請畫出初始對象圖5.3 對象模型圖6. 對象數(shù)據(jù)字典描述在這個部分敘述每個對象的細節(jié)，它的屬性、它的方法。在這之前必須從邏輯上對對象進行組織。你可能需要用結構圖把對象按子系統(tǒng)劃分好。為每個對象做一個條目。在系統(tǒng)對象模型中簡要的描述它的用途、約束（如只能有一個實例），列出它的屬性和方法。如果對象是存儲在持久的數(shù)據(jù)容器中，標明它是持久對象，否則說明它是個臨時對象（transient object）。對每個對象的每個屬性詳細說明：名字、類型，如果屬性不是很直觀或者有約束（例如，每個對象的該屬性必須有一個唯一的值或者值域是有限正整數(shù)等）。對每個

10、對象的每個方法詳細說明：方法名，返回類型，返回值，參數(shù)，用途以及使用的算法的簡要說明（如果不是特別簡單的話）。如果對變量或者返回值由什么假定的話，Pre-conditions和Post-conditions必須在此說明。列出它或者被它調用的方法需要訪問或者修改的屬性。最后，提供可以驗證實現(xiàn)方法的測試案例。6.1 子系統(tǒng)1中的對象6.1.1 對象：對象1用途：約束：持久性：6.1.1.1 屬性描述：1. 屬性：屬性1類型：描述：約束：2. 屬性：屬性26.1.1.2 方法描述：1. 方法：方法1返回類型：參數(shù)：返回值：Pre-Condition：Post-Condition：讀取/修改的屬性：調

11、用的方法：處理邏輯：測試例：用什么參數(shù)調用該方法，期望的輸出是什么7. 動態(tài)模型這部分的作用是描述系統(tǒng)如何響應各種事件。例如，可以建立系統(tǒng)的行為模型。一般使用順序圖和狀態(tài)圖。確定不同的場景（Scenario）是第一步，不需要確定所有可能的場景，但是必須至少要覆蓋典型的系統(tǒng)用例。不要自己去想當然地創(chuàng)造場景，通常的策略是描述那些客戶可以感受得到的場景。7.1 場景（Scenarios）對每個場景做一則條目，包括以下內容：場景名：給它一個可以望文生義的名字場景描述：簡要敘述場景是干什么的以及發(fā)生的動作的順序。順序圖：描述各種事件及事件發(fā)生的相對時間順序。7.1.1 場景：場景1描述：動作1動作27.2事件定義（Events）文字定義事件畫出事件跟蹤圖畫出事件流圖7.3 狀態(tài)圖這部分的內容包括系統(tǒng)動態(tài)模型重要的部分的狀態(tài)圖?？赡苣阆霝槊總€對象畫一個狀態(tài)圖，但事實上會導致太多不期望的細節(jié)信息，只需要確定系統(tǒng)中一些重要的對象并為之提供狀態(tài)圖即可。7.3.1 狀態(tài)圖18. 功能模型8.1 確定輸入輸出與事件關系8.2 功能模型圖功能模型圖有很多，請分開表示8.2.1 對象1的功能模型圖8.2.2 對象2的功能模型圖9. 數(shù)據(jù)