理順軟件開發各個環節-7（需求管理-軟件需求-4）

4.4.4數據字典（DD）的編寫要點及示例

　　數據字典（Data Dictionary，簡稱DD），對軟件需求涉及的數據項進行定義。
　　數據字典的做用以下：

• 數據項的定義，便於澄清基本概念，俗話說，基礎不牢，地動山搖；有了數據項定義，便於SRS的各個閱讀者準確地理解需求；
• 爲閱讀軟件需求規格書的各方提供一致的數據項定義，有助於消除各方理解的誤差，避免發生雞同鴨講的事情。

　　這裏分享一下我以前一直使用的數據字典的文檔模板，相對其它的數據字典文檔模板，數據項描述要繁瑣一些，但更能將數據項描述清楚。

　　章節一、概述
　　章節1.一、編寫目的
　　數據字典，爲定義應用所使用的全部數據元素和結構的定義、類型、數據大小、格式、度量單位、精度以及容許取值範圍的共享倉庫。
　　編寫本數據字典，提供[XX產品或項目]的需求文檔和設計開發文檔一致的概念定義。
　　本數據字典的預期讀者爲本產品的用戶、產品經理、分析、設計、開發、編程和測試人員。

　　章節1.二、背景
　　產品/項目名稱：[XXX]

　　章節1.三、編寫規則
　　章節1.3.一、編號規則
　　一級標題，按用戶級功能定義，子標題按須要展開。
　　不使用具體的編號。分別查看，可以使用文檔結構圖。

　　章節1.3.二、數據項描述規則
　　使用下列格式描述數據項（容許部份內容爲空）：
　　中文名：（數據項名稱）
　　英文名：（英文全名）
　　簡稱：（英文縮寫）
　　顯示名稱：（英文顯示名稱，若是須要顯示中文，且與中文名不一樣，也在此處說明。）
　　通常描述：
　　數據項定義：
　　補充說明：
　　內容示例：

　　注：　　

• 若是中文名或英文名與數據項標題相同，爲維護方便性，可爲空；
• 數據項支持嵌套，即一個大的結構能夠分解爲多個子結構。

　　章節1.3.三、數據項定義規則
　　在數據定義中，可使用簡單的符號表示數據項。項寫在等號的左邊，而其定義寫在右邊。這種符號定義了原始數據、組成結構體的複雜數據元素、重複的數據項、一個數據項的枚舉值以及可選的數據項。
　　原數據元素 一個原數據元素是不可分解的。能夠給它賦予一個數量值。原數據的定義必須肯定其數據類型、大小、容許取值的範圍等等。典型的原數據元素的定義是一行註釋文本，並以星號做爲界限：
　　請求標識號 = *6位系統生成的順序整數，以1開頭，並能惟一標識每一個請求*

　　組合項 一個數據結構或記錄包含了多個數據項。若是數據結構中的項是可選的，就把它用括弧括起來：
　　請求的化學制品 = 化學制品標識號
　　　　+ 數量
　　　　+ 數量單位
　　　　+ （供應商名稱）
　　這個結構肯定了與請求一種特定化學制品相關的全部信息。供應商名稱是可選的，由於提出請求的人並不關心化學制品是從哪一個供應商處購買的。每一個出如今結構中的數據項都必須寫入數據字典。結構中還能夠包含其它結構。

　　重複項 若是一個項的多個實例將出如今數據結構中，就把該項用花括弧括起來。若是知道可能容許的重複次數，就用「最小值： 最大值」這種形式寫在擴號以前：
　　請求= 請求標識號
　　　　+ 產品編號
　　　　+ 1:10{請求的化學制品}
　　這個例子代表，一個化學制品的請求至少包含一種化學制品，但不能多於10種。每一個請求也包括一個單一的請求標示號和一個產品編號，它們的格式將在數據字典的其它地方定義。

　　選擇項 若是一個原數據項元素能夠取得有限的離散值，就把這些值列舉出來：
　　數量單位= [「克」 | 「千克」 | 「個」 ]
　　*文本串表示了與所請求的化學制品的量相關的單位*
　　代表了數量單位的文本串只容許3種取值。註釋提供了數據項定義的信息。

　　章節1.3.四、引用規則
　　本文中的引用規則。
　　章節1.3.4.一、術語引用
　　使用：斜體+下劃線。
　　視須要引用。
　　章節1.3.4.二、字典數據項引用
　　使用斜體。

　　章節1.四、參考文獻

　　章節二、術語
　　參考SRS的術語表格。

　　章節三、用戶帳號
　　中文名：
　　英文名：User Account
　　簡稱：
　　顯示名稱：User Account
　　通常描述：使用本系統的用戶帳號信息。
　　數據項定義：
　　用戶帳號=[APP用戶帳號 | 管理後臺用戶帳號]
　　補充說明：
　　APP用戶帳號不能和管理後臺用戶帳號混用，即APP用戶帳號不能登陸管理後臺，一樣管理後臺用戶帳號也不能登陸APP。
　　內容示例：

　　章節3.一、APP用戶帳號
　　中文名：
　　英文名：App User Account
　　簡稱：
　　顯示名稱：App User Account
　　通常描述：使用本系統的App用戶帳號信息。
　　數據項定義：
　　APP用戶帳號= 帳號類型
　　　　+ 帳號名
　　　　+ 註冊類型
　　　　+ 帳號密碼
　　　　+ 帳號基本信息
　　　　+ 帳號附加信息

　　補充說明：
　　帳號類型 = [APP用戶帳號|管理後臺用戶帳號]
　　此處帳號類型限定爲APP用戶帳號。

　　帳號名=*惟一識別用戶帳號的名稱*
　　帳號名可使用第一次註冊的名稱，即手機號或EMail郵箱地址。

　　註冊類型 = [手機號註冊|EMail郵箱地址註冊]

　　帳號密碼 = 大小寫英文字母或數字開頭，後面爲大小寫英文字母或數字或字符[」_」|」-」|」*」|」#」]，總長度爲6~18個字符。

　　內容示例：

　　章節3.二、管理後臺用戶帳號
　　中文名：
　　英文名：Admin User Account
　　簡稱：
　　顯示名稱：Admin User Account
　　通常描述：使用本系統的管理後臺用戶帳號信息。
　　數據項定義：
　　管理用戶帳號= 帳號類型
　　　　+ 帳號名
　　　　+ 註冊類型
　　　　+ 帳號密碼
　　　　+ 帳號基本信息
　　　　+ 帳號公司信息

　　補充說明：
　　帳號類型 = [APP用戶帳號|管理後臺用戶帳號]
　　此處帳號類型限定爲管理後臺用戶帳號。

　　帳號名=*惟一識別用戶帳號的名稱，用於管理後臺的登陸名*
　　帳號名由管理員分配，使用EMail郵箱地址做爲帳號名稱。

　　註冊類型 =*管理員分配*

　　帳號密碼 = 大小寫英文字母或數字開頭，後面爲大小寫英文字母或數字或字符[」_」|」-」|」*」|」#」]，總長度爲6~18個字符。

　　內容示例：

　　章節3.三、帳號基本信息
　　中文名：
　　英文名：Account base infomation
　　簡稱：
　　顯示名稱：Account base info.
　　通常描述：用戶帳號的基本信息。
　　數據項定義：
　　帳號基本信息= 手機號
　　　　+ EMail郵箱地址
　　　　+ 用戶暱稱
　　　　+ 用戶頭像

　　補充說明：
　　手機號 = *國內移動運營商的手機號，11位數字，視須要將某些號段排除在外，容許爲空*
　　若是爲手機號註冊，則即爲註冊的手機號；

　　EMail郵箱地址=*符合郵箱地址命名的字符串，容許爲空*
　　若是爲EMail郵箱地址註冊，則即爲註冊的EMail郵箱地址；
　　若是爲手機號註冊，則要求不能在其它帳號的帳號名或EMail郵箱地址數據項中使用過，不然認爲是同一個帳號，啓動帳號合併流程。

　　用戶暱稱=*支持中英文、數字和可見ASCII碼及emoji表情，長度上限60個字符*

　　用戶頭像 =[jpg|png|bmp]格式，限制250*250像素。

　　內容示例：

　　章節3.四、帳號附加信息
　　......

　　章節3.五、帳號公司信息
　　......

　　章節四、數據項集合2　　......