其次,妳要確定妳采用的周期模型和開發方法。不同的模型或者方法會有不同的文檔需求,需要妳自己去量身定制,直到適合妳的開發團隊。別忘了,文檔也是用來提高開發效率和質量的,開發者寫太多無味的文檔會降低效率。
第三,妳要做壹些文檔模板,明確說明文檔的用途和結構。
最後可以填充了。
附上RUP需求描述文檔模板。
1.0簡介
[介紹本文件的整體結構。]
1.1目的
[解釋本軟件需求規範的目的。軟件需求規格說明書不僅需要完整地描述系統的行為,還需要解釋非功能需求、設計約束等相關因素。]
1.2範圍
[簡要介紹本需求規格文件適用的項目/應用程序及其主要功能或其他子系統、相關用例模型以及受其影響的任何其他內容。]
1.3定義、術語和縮寫
【詳細定義】正確理解本文檔中的相關術語,包括定義、首字母縮寫詞和縮略語。可以參考詞匯表解釋壹下。]
1.4
[描述本文件中引用的任何其他相關文件。列出文件的標題、文件編號、日期和出版單位,並說明文件的來源。]
1.5匯總
[解釋本文件其余部分的內容和結構。]
2.0描述
[本節列出了影響產品和要求的壹般因素,但不必列出具體要求,只需描述將在第3節中詳細描述的要求的背景,以便於理解要求。這包括:整體產品效果、產品功能、用戶特征、約束、假設和依賴、需求子集。解釋產品是什麽或不解決什麽,以及產品不解決或不解決什麽尤為關鍵。]
2.1用例模型
[如果使用了用例模型,本節概述了適用於該系統的用例模型或子模型,包括所有用例及角色的名稱和簡要描述,以及用例圖和關系。用例報告可以在這裏作為附件引用。]
2.2假設和依賴性
[說明所有重要的技術可行性、子系統或組件的可用性或可用作本規範所述軟件基礎的其他相關假設。]
3.0要求描述
【詳細描述軟件的需求。它的詳細程度使設計者能夠設計出滿足這些需求的系統;測試人員可以測試系統是否真正滿足這些需求。當使用用例建模時,這些需求被用例以及其他可用的補充文檔所捕獲。]
3.1用例報告
【用例模型通常定義系統的主要功能需求和壹些非功能需求。對於用例模型中的每個用例,您需要在這裏引用或附加壹個用例報告。確保每個要求都有明確的標記。]
3.2補充說明
[描述用例中沒有包括的其他需求。補充需求描述中適用於該系統的特定需求描述或特征應包含在此處,並進行細化以足夠詳細地描述該系統。這些信息可以直接記錄在本文件中,也可以作為單獨補充文件的附件引用。還要確保明確定義了需求。]
4.0輔助信息
[輔助信息使本文檔更易於使用。這可以是目錄、索引、附錄、用例圖、用戶界面原型等。如果包含附錄,請明確該附錄是否是要求的壹部分。]