當前位置:歷史故事大全網 - 圖書館 - 軟件詳細設計規範

軟件詳細設計規範

面向對象軟件設計規範模板

1概述

1.1系統簡介

對系統要完成的內容、面對的用戶以及系統運行的環境的簡要描述,主要來源於需求說明書的開頭。

1.2軟件設計目標

這壹部分討論了整個系統的設計目標,明確說明了系統決定實現哪些功能,不打算實現哪些功能。同時也要提到性能、可用性等非功能性需求。需求規格是這壹部分的重要參考。看看it中定義的功能性和非功能性需求。

這壹部分必須清楚地說明整體設計,並確保讀者在閱讀後知道該系統將具有什麽特性和功能。在下面的文檔部分,我們將解釋設計如何實現這些。

1.3引用

列出本文件中引用的參考文獻。(至少引用需求說明書)

1.4修訂記錄

列出此文檔的修改歷史。必須指定修改的內容、日期和修改人。

2詞匯表

解釋本文檔中使用的各種術語。如果需求說明書中已經解釋了壹些術語,這裏就不需要重復了,可以引導讀者參考需求說明書。

3個使用案例

這裏要求系統用用例圖(UML)表示,每個用例(正常處理情況)都要用中文描述。

4設計概述

4.1簡介

這部分要求突出整個設計中使用的方法(面向對象設計或結構化設計)、系統架構(如客戶機/服務器結構)以及使用的相應技術和工具(如OMT和羅斯)。

4.2系統結構設計

這壹部分要求描述高層次的系統結構,並使用框圖來顯示主要組件和組件之間的交互。最好把邏輯結構和物理結構分開,描述前者。別忘了解釋圖片中使用的成語和符號。

4.2.1頂層系統結構

4.2.2子系統1結構

子系統2的結構

4.3系統界面

這裏描述了提供給用戶和外部系統的各種接口。如果用戶界面已經在需求說明書中描述過,這裏就沒有必要重復了,可以引導讀者參考需求說明書。如果系統提供了與其他系統的接口,例如從其他軟件系統導入/導出數據,則必須在此說明。

4.4約束和假設

描述系統設計中最重要的約束,這些約束是客戶強制要求的,並在需求規格中說明。解釋系統如何適應這些約束。

此外,如果該系統與其他外部系統進行交互,或者依賴其他外部系統提供壹些功能性幫助,那麽該系統可能會受到其他約束。在這種情況下,需要清楚地描述與該系統交互的軟件類型(如XXX數據庫軟件和XXX郵件軟件)以及由此導致的約束(如只允許純文本郵件)。

實現的語言和平臺也會對系統有約束,這裏也有解釋。

對於選擇具體的設計實現對系統造成的約束,簡單描述壹下妳的想法,什麽樣的權衡,為什麽要采用這樣的設計等等。

5對象模型

5.1系統對象模型

提供整個系統的對象模型。如果模型太大,就按照可行的標準分成小塊。例如,客戶端和服務器的對象模型可以分為兩個圖。

對象圖應該包含什麽?

它應該包含所有系統對象。這些對象來自於對需求的理解。要清楚什麽應該放入圖表,什麽不應該放入圖表。

必須確定所有對象之間的關聯,並且必須指明關聯的基數(壹對壹、壹對多或多對多,0...1, *, 1 ...*).必須明確定義聚合和繼承之間的關系。每個數字必須附有簡單的解釋。

可能需要多次叠代才能獲得正確的系統對象模型。

6對象描述

在這壹部分中,描述了每個對象的細節、屬性和方法。在此之前,必須對對象進行邏輯組織。您可能需要使用結構圖將對象分成子系統。

為每個對象創建壹個條目。在系統對象模型中簡要描述其用途和約束條件(如只有壹個實例),並列出其屬性和方法。如果對象存儲在持久數據容器中,則指示它是持久對象;否則,指示它是臨時對象。

詳細解釋每個對象的每個屬性:名稱,類型,如果屬性不是很直觀或者有約束(比如每個對象的屬性必須有唯壹值或者取值範圍是有限正整數等。).

每個對象的每個方法的詳細描述:方法名、返回類型、返回值、參數、用途以及所用算法的簡要描述(如果不是特別簡單的話)。如果假設變量或返回值,則必須在此說明前置條件和後置條件。列出它或它調用的方法需要訪問或修改的屬性。最後,通過壹個測試案例驗證了該實現方法。

6.1子系統1中的對象

6.1.1對象:對象1

使用:

約束條件:

持久性:

6.1.1.1屬性描述:

1.屬性:屬性1

類型:

描述:

約束條件:

2.屬性:屬性2

6.1.1.2方法描述:

1.方法:方法1。

返回類型:

參數:

返回值:

先決條件:

後置條件:

讀取/修改的屬性:

被調用的方法:

處理邏輯:

測試用例:使用什麽參數來調用這個方法,預期的輸出是什麽...

7動態模型

這部分的功能是描述系統如何響應各種事件。例如,可以建立系統的行為模型。壹般用序列圖和狀態圖。

確定不同的場景是第壹步。沒有必要確定所有可能的場景,但至少必須涵蓋典型的系統用例。不要想當然的自己去創造場景。通常的策略是描述那些客戶能感受到的場景。

7.1場景

為每個場景創建壹個條目,包括以下內容:

場景的名字:給它壹個有意義的名字。

場景描述:簡要描述場景做什麽,動作順序。

序列圖:描述各種事件及其相對時序。

7.1.1場景:場景1

描述:

行動1

行動2

7.2狀態圖

這壹部分包括系統動態模型重要部分的狀態圖。也許妳想為每個對象畫壹個狀態圖,但實際上會導致太多意想不到的細節。妳只需要確定系統中的壹些重要對象,給它們提供狀態圖。

7.2.1狀態圖1:

8個非功能性需求

在本節中,有必要解釋如何處理需求文檔中指定的非功能性需求。盡可能客觀地評估系統處理每個非功能性需求的能力。如果壹些非功能性需求在設計的系統中沒有完全實現,請務必在此說明。此外,妳還需要估計系統未來的演變,描述這種設計如何使系統適應這些可預見的變化。

9輔助文件

提供有助於理解設計的相關文檔。

10詞匯索引

文章條目

  • 上一篇:關於責任有名言。
  • 下一篇:合肥中心圖書館業主群
  • copyright 2024歷史故事大全網