本文將分享一般的需求說明書該如何撰寫,有哪些格式,需要注意什么等方面,力求使需求說明書看起來規范、專業。
一、文檔結構
1. 首頁
先說需求說明書的首頁,首頁展示本公司的基本信息、需求說明書的標題,如XX產品需求規格說明書,和文檔編號、編寫人、模塊名稱、部門、保密等級、日期、版權說明等。
2. 修訂頁
修訂頁的作用是記錄需求說明書版本的變更,在跟客戶溝通需求的時候,需求可能會變更,每一次修訂,都需記錄下來,作為留痕。
修訂頁展示的內容包括編號、章節名稱、修訂內容簡述、修訂日期、修訂前版本號、修訂后版本號、修訂人、批准人。
3. 目錄
目錄即是需求說明書正文的內容,包含了引言、項目概述、業務需求、附錄。
(1)引言:展示編寫目的、范圍、定義和參考資料。
- 編寫目的:說明編寫這份軟件需求說明書的目的,指出預期的讀者范圍。
- 范圍:待開發的軟件系統的名稱;說明軟件將干什么,如果需要的話,還要說明軟件產品不干什么;描述所說明的軟件的應用,盡可能精確地描述所有相關的利益、目的、以及最終目標。
- 定義:列出本文件中用到的專門術語的定義和縮寫詞的原詞組。
(2)項目描述:如果是項目需求,簡要描述一下項目的概況,如項目的背景,項目的周期等等。
- 產品描述:敘述該項軟件開發的意圖、應用目標、作用范圍以及其他應向讀者說明的有關該軟件開發的背景材料。如果開發的系統與其他系統有對接,則還應該本系統與其他系統之間的關系,用方框圖表示。
- 產品功能:系統包含的模塊,並簡要描述下各模塊的功能。描述產品功能模塊的作用是將系統的范圍定義清楚,一共有多少個模塊,以便甲乙兩方明確本次項目的邊界。
(3)業務需求:用戶提出的需求
- 功能介紹:描述功能要達到的目標、所彩的方法和技術,還應清楚說明功能意圖的由來和背景。
- 流程圖:如果涉及到流程,除了文字以外,還需附上流程圖
- 數據項描述:展示字段、字段類型(文本、日期、數值、枚舉值等)、數據來源、備注,開發看到數據項描述能定義數據庫表中的字段。
- 界面展示:原型圖輸出,用原型圖方式呈現文字描述的功能,每張原型圖下面可以備注功能的路徑,以便開發明白該原型圖在哪個模塊的哪個菜單。
(4)附錄:對一個實際的需求規格說明來說,若有必要應該編寫附錄。
附錄包括有助於理解需求說明的背景信息、用戶歷史、背景、經歷和操作特點、原始需求、需求調研記錄等等。需要注意的是當包括附錄時,需求說明必須明確地說明附錄只作為參考,不作為正式的需求。
因為有時候一些原始需求,在需求溝通過程或者其他原因,可能會不做,原始的需求和正式要開發的需求不一定是相同的,所以要用文字說明附錄不作為正式開發的需求,也不作為驗收的標准。
最后,如果需求說明書需要用戶簽名,還需在后面寫上用戶公司名稱、日期,以及本公司名稱和日期。
以上是文檔結構部分,為了使一份需求說明書看起來專業,還需注意細節部分。
二、文檔細節
- 頁眉頁腳: 頁眉注明是XX公司的需求說明書;頁腳要編寫頁碼,如第幾頁,但是首頁不要頁眉頁腳。
- 字體字號:正文的字體建議用宋體,字號用5號。需求說明書不要出現3種字體。
- 行距:1.5倍行距
需求說明書可以向開發和用戶展現需求分析師的實力,專業的需求說明書能體現需求分析師的專業水平,可以說需求說明書是需求分析師的一件“外衣”,專業的需求分析師寫出的需求不僅是用戶開發能看懂,而且整篇文檔的結構完整,細節也相當注意。
軟件需求說明書的一個例子:
https://blog.csdn.net/bingocoder/article/details/89160757