【正文】 大學(xué)生校園網(wǎng) 努力打造的學(xué)生最實用的網(wǎng)絡(luò)平臺！ 更多精彩，盡在大學(xué)生校園網(wǎng) 21 附錄 B 軟件概要設(shè)計報告文檔模板 1. 引言 ........................................................................................................................................................... 23 編寫目的 ............................................................................................................................................. 23 項目風(fēng)險 ......................................................................................。 大學(xué)生校園網(wǎng) 努力打造的學(xué)生最實用的網(wǎng)絡(luò)平臺！ 更多精彩，盡在大學(xué)生校園網(wǎng) 20 8. 分析模型 這是一個可選部分，包括或涉及到相關(guān)的分析模型，例如： ● 數(shù)據(jù)流程圖； ● 類圖； ● 狀態(tài)轉(zhuǎn)換圖 ； ● 實體 關(guān)系圖。 ● 重復(fù)項 重復(fù)項是組合項的一種特例，其中有一項將有多個實例出現(xiàn)在數(shù)據(jù)結(jié)構(gòu)中，使用花括號 把該項括起來。其中每個數(shù)據(jù)項都必須是數(shù)據(jù)定 義中定義過的，結(jié)構(gòu)中也可以包括其它結(jié)構(gòu)，但是絕對不允許遞歸。 ● 組合項 組合項是一個數(shù)據(jù)結(jié)構(gòu)或者記 錄，其中包含了多個數(shù)據(jù)項。 ● 選擇項 選擇項是一種只可以取有限離散值的特殊原數(shù)據(jù)元素，描述時一一枚舉這些值，并用方 括號括起來寫在原數(shù)據(jù)元素的定義前。定義原數(shù)據(jù)元素必須確定其 含義、類型、數(shù)據(jù)大小、格式、計量單位、精度以及取值范圍。可以使用等號表示數(shù)據(jù)項，名稱寫在左邊，定義寫在右邊。必須注意的是，為了避免二義性，在匯總數(shù)據(jù)項時應(yīng)該根據(jù)數(shù)據(jù)項所代表的實際意義匯總，而不是根據(jù)數(shù)據(jù)項的名稱匯總。但是卻不利于多人協(xié)同編寫需求分析報告，容易遺漏數(shù)據(jù)，也不方便閱讀。數(shù)據(jù)定義的維護獨立于軟件需求規(guī)格說明，并且在軟件產(chǎn)品開發(fā)和維護的任何階段，均向風(fēng)險承擔(dān) 者開放。但是，對于無法回避的軟件專業(yè)或者計算機專業(yè)術(shù)語，也應(yīng)該列入詞匯表并且加以準確定義。為了便于非軟件專業(yè)或者非計算機 專業(yè)人士閱讀軟件產(chǎn)品需求分析報告，要求使用非軟件專業(yè)或者非計算機專業(yè)的術(shù)語描述軟件需求。 用戶文檔 列舉出將與軟件產(chǎn)品一同交付的用戶文檔，并且明確所有己知用戶文檔的交付格式或標(biāo)準，例如： ● 安裝指南 紙質(zhì)文檔， 16 開本； ● 用戶手冊 紙質(zhì)文檔， 16 開本； ● 在線幫助 ● 電子文檔，與軟件產(chǎn)品一同分發(fā)、配置； ● 使用教程電子文檔，與軟件產(chǎn)品一同分發(fā)、配置。一個業(yè)務(wù)規(guī)則的范例如下：“進行達到或者 超過 10， 000， 00 元人民幣的儲蓄業(yè)務(wù)時，必須通過附加的管理員認證。 業(yè)務(wù)規(guī)則 列舉出有關(guān)軟件產(chǎn)品的所有操作規(guī)則，例如：那些人在特定環(huán)境下可以進行何種操作。這些功能必須是確定的、定量的、在需要時是可以驗證的。一個典型的軟件系統(tǒng)安全需求 范例如下：“每個用戶在第一次登錄后，必須更改他的系統(tǒng)預(yù)置登錄密碼，系統(tǒng)預(yù)置的登錄密碼不能重用。明確軟件產(chǎn)品必須滿足的安全性或者保密性策略。這些問題將會影響到軟件產(chǎn)品的使用，和軟件產(chǎn)品所創(chuàng)建或者使用的數(shù)據(jù)的保護。明確軟件產(chǎn)品必須遵從的安全標(biāo)準、策略、或規(guī)則。 安全措施需求 詳盡陳述與軟件產(chǎn)品使用過程中可能發(fā)生的損失、破壞、危害相關(guān)的需求。盡可能詳細地描述性能需求，如果需要，可以針對每個功能需求或者特征分別陳述其性能需求。 5. 其它非功能需求 在這里列舉出所有非功能需求，主要包括可靠性、安全性、可維護性、可擴展性、可測試性等。 對于每一項數(shù)據(jù)，均需要描述： ● 數(shù)據(jù)名稱； ● 實際含義； ● 數(shù)據(jù)類型； ● 數(shù)據(jù)格式； ● 數(shù)據(jù)約束； 對于復(fù)雜的處理方法，僅僅給出算法原理是不夠的，必須描述詳細的計算過程，并且列出每一步具體使用的實際算式；如果計算過程中涉及查表、判斷、迭代等處理方法 ，應(yīng)該給出處理依據(jù)和相關(guān)數(shù)據(jù)。 輸入／輸出數(shù)據(jù) 列出輸入數(shù)據(jù) (用戶輸入、來自外部接口的輸入或者其它輸入 )并且定義針對這些輸入數(shù)據(jù)的處理 (計算 )方法，以及相應(yīng)地輸出數(shù)據(jù)，描述對應(yīng)區(qū)別：輸入數(shù)據(jù)和輸出數(shù)據(jù)。疏忽了可選過程，有可能影響軟件產(chǎn)品的功能；如果遺漏例外過程，則有可能會引發(fā)系統(tǒng)崩潰。 激勵／響應(yīng)序列 列出輸入激勵 (用戶動作、來自外部設(shè)備的信號或者其它觸發(fā) )并且定義針對這 —— 功能行為的系統(tǒng)響應(yīng)序列，這些序列將與使用實例中相關(guān)的對話元素相對應(yīng)。 說明和優(yōu)先級 對該系統(tǒng)功能進行簡短的說明，并且指出該系統(tǒng)功能的優(yōu)先級是：高、中、還是低。 對應(yīng)一些被共享的獨立使用實例，可以定義一些公用系統(tǒng)功能。其最終目的是，讓讀者容易理解即將開發(fā)的軟件產(chǎn)品。無論說明的是何種功能，都應(yīng)該針對該系統(tǒng)功能重復(fù)敘述 ~ 這三個部分。 用簡短的語句說明功能的名稱，例如：“ 系統(tǒng)參數(shù)管理”。可以通過使用實例、運行模式、用戶類、對象類或者功能等級來組織這部分內(nèi)容，也可以便用這些元素的組合。如果某項功能需求找不 到合適的測試用例，或者必須使用多項測試用例才能驗證，那么該項功能需求的描述必然存在某些問題。描述軟件產(chǎn)品如何響應(yīng)己知的出錯條件、非法輸入、非法動作。 通訊接口 描述與軟件產(chǎn)品所使用的通訊功能相關(guān)的需求，包括： ● 電子郵件； ● WEB瀏覽器； ● 網(wǎng)絡(luò)通訊標(biāo)準或者協(xié) 議； ● 數(shù)據(jù)交互用電子表格； 必須定義相關(guān)的： ● 消息格式； ● 通訊安全或加密問題； ● 數(shù)據(jù)傳輸速率； ● 同步和異步通訊機制； 4. 系統(tǒng)功能需求 需要進行詳細的需求記錄，詳細列出與該系統(tǒng)功能相關(guān)的詳細功能需求，并且，唯一地標(biāo)識每一項需求。確定軟件產(chǎn)品將與組件之間共享的數(shù)據(jù)。 描述并且明確軟件產(chǎn)品與軟件組件之間交換數(shù)據(jù)或者消息的目的。接口特征的描述內(nèi)容可能包括： ● 支持的硬件類型； ● 軟、硬件之間交流的數(shù)據(jù)； ● 控制信息的性質(zhì)； ● 使用的通訊協(xié)議； 軟件接口 描述該軟件產(chǎn)品與其它外部組件的連接，這些外部組件必須明確它們的名稱和版本號以資識別，可能的外部組件包括： ● 操作系統(tǒng)； ● 數(shù)據(jù)庫； ● 工具； ● 函數(shù)庫； ● 集成的商業(yè)組件 說明：這里所說的“集成的商業(yè)組件”，是指與系統(tǒng)集成的商業(yè)組件，而不是與軟件產(chǎn)品集成的商業(yè)組件。 如果采用現(xiàn)成的、合適的用戶界面設(shè)計規(guī)范 (標(biāo)準 )，或者另文描述，可以在這里直接說明，并且將其加入?yún)⒖嘉墨I。以下是可能包括的一些特征： 大學(xué)生校園網(wǎng) 努力打造的學(xué)生最實用的網(wǎng)絡(luò)平臺！ 更多精彩，盡在大學(xué)生校園網(wǎng) 15 ● 將要采用的圖形用戶界面 (GUl)標(biāo)準或者產(chǎn)品系列的風(fēng)格； ● 有關(guān)屏幕布局或者解決方案的限制； ● 將要使用在每一個屏幕 (圖形用戶界面 )上的軟件組件，可能包括： ? 選單； ? 標(biāo)準按鈕； ? 導(dǎo)航鏈接； ? 各種功能組件； ? 消息欄； ● 快捷鍵； ● 各種顯示格式的規(guī)定，可能包括： ? 不同情況下文字的對齊方式； ? 不同情況下數(shù)字的表現(xiàn)格式與對齊方式 ? 日期的表現(xiàn)方法與格式； ? 計時方法與時間格式； ? 等等。 用戶界面 陳述需要使用在用戶界面上的軟件組件，描述每一個用戶界面的邏輯特征。如果產(chǎn)品的不同部分有不同的外部接口，那么應(yīng)該把這些外部接口的全部詳細需求并入到這一部分實例中。有關(guān)的約束可能包括： ● 工期約束； ● 經(jīng)費約束； ● 人員約束； ● 設(shè)備約束； ● 地理位置約束； ● 其它有關(guān)項目約束； 3. 外部接口需求 通 過本節(jié)描述可以確定，保證軟件產(chǎn)品能和外部組件正確連接的需求。 )； ● 有關(guān)本軟件開發(fā)工作的若干假定 (例如：用戶承諾的優(yōu)惠、方便、上級部門給予的特殊政策和支持等。如果這些假設(shè)因素不正確、不一致或者被修改，就會使軟件產(chǎn)品 開發(fā)項目受到影響?？赡艿?限制包括下列內(nèi)容： ● 必須使用的特定技術(shù)、工具、編程語言和數(shù)據(jù)庫； ● 避免使用的特定技術(shù)、工具、編程語言和數(shù)據(jù)庫； ● 要求遵循的開發(fā)規(guī)范和標(biāo)準 大學(xué)生校園網(wǎng) 努力打造的學(xué)生最實用的網(wǎng)絡(luò)平臺！ 更多精彩，盡在大學(xué)生校園網(wǎng) 14 例如，如果由客戶的公司或者第三方公司負責(zé)軟件維護，就必須定義轉(zhuǎn)包者所使用的設(shè)計符號表示和編碼標(biāo)準； ● 企業(yè)策略的限制； ● 政府法規(guī)的限制； ● 工業(yè)標(biāo)準的限制； ● 硬件的限制 例如，定時需求或存儲器限制； ● 數(shù)據(jù)轉(zhuǎn)換格式標(biāo)淮的限制。 運行環(huán)境 描述了本軟件的運行環(huán)境，一般包括： ● 硬件平臺； ● 操作系統(tǒng)和版本； ● 支撐環(huán)境 (例如：數(shù)據(jù)庫等 )和版本； ● 其它與該軟件有關(guān)的軟件組件； ● 與該軟件共存的應(yīng)用程序。 用戶不一定是軟件產(chǎn)品的直接使用者，通過報表、應(yīng)用程序接口、系統(tǒng)硬件接口得到軟件產(chǎn)品的數(shù)據(jù)和服務(wù)的人、或者機構(gòu)也有他們的需求。往往有一些軟件需求，只與特定的用戶類有關(guān)。 參考用戶當(dāng)前管理組織構(gòu)架，了解各個機構(gòu)的主要職能，將有助于陳述軟件產(chǎn)品的主要功能。 為了很好地組織產(chǎn)品功能，使每個讀者都容易理解，可以采用列表的方法給出。僅從業(yè)務(wù)層面陳述本軟件產(chǎn)品所應(yīng)具有的主要功能，在描述功能時應(yīng)該針對每一項需求準確地描述其各項規(guī)格說明。 那么必須說明軟件產(chǎn)品需求分析報告定義的這部分軟件是怎樣與整個大系統(tǒng)相關(guān)聯(lián)的，或者（同時）說明相互關(guān)系的存在形式，并且要定義出兩者之間的全部接口。說明了該軟件產(chǎn)品是否屬于下列情況： ● 是否是產(chǎn)品系列中的下一成員； ● 是否是成熟產(chǎn)品所改進的下一代產(chǎn)品； ● 是否是現(xiàn)有應(yīng)用軟件的替代品 (升級產(chǎn)品 )； ● 是否是一個新 型的、自主型的產(chǎn)品。 2. 綜合描述 這一部分概述了正在定義的軟件產(chǎn)品的作用范圍以及該軟件產(chǎn)品所運行的環(huán)境、使用該軟件產(chǎn)品的用戶、對該軟件產(chǎn)品己知的限制、有關(guān)該軟件產(chǎn)品的假設(shè)和依賴。 參考文獻 列舉編寫軟件產(chǎn)品需求分析報告時所用到的參考文獻及資料，可能包括： ● 本項目的合同書； ● 上級機關(guān)有關(guān)本項目的批文； ● 本項目已經(jīng)批準的計劃任務(wù)書； ● 用戶界面風(fēng)格指導(dǎo)； ● 開發(fā)本項目時所要用到的標(biāo)淮； ● 系統(tǒng)規(guī)格需求說明； ● 使用實例文檔； ● 屬于本項目的其它己發(fā)表文件； ● 本軟件產(chǎn)品需求分析報告中所引用的文件、資料； ● 相關(guān)軟件產(chǎn)品需求分析報告； 為了方便讀者查閱，所有參考資料應(yīng)該按一定順序排列。把軟件產(chǎn)品開發(fā)與 企業(yè)目標(biāo)，或者業(yè)務(wù)策略相聯(lián)系。 并且描述了文檔中，其余部分的內(nèi)容及其組織結(jié)構(gòu)，并且針對每一類讀者提出最適合的大學(xué)生校園網(wǎng) 努力打造的學(xué)生最實用的網(wǎng)絡(luò)平臺！ 更多精彩，盡在大學(xué)生校園網(wǎng) 12 文檔閱讀建議。排版約定應(yīng)該包括： ● 正文風(fēng)格； ● 提示方式； ● 重要符號； 也應(yīng)該說明高層次需求是否可以被其所有細化的需求所繼承，或者每個需求陳述是否都有其自己的優(yōu)先級。 項目風(fēng)險 具體說明本軟件開發(fā)項目的全部風(fēng)險承擔(dān)者，以及各自在本階段所需要承擔(dān)的主要風(fēng)險，首要風(fēng)險承擔(dān)者包括： ● 任務(wù)提出者； ● 軟件開發(fā)者； ● 產(chǎn)品使用者。通過這份軟件產(chǎn)品需求分析報告詳盡說明了該軟件產(chǎn)品的需求規(guī)格，包括修正和 (或 )發(fā)行版本號，從而對該軟件產(chǎn)品進行準確的定義。 大學(xué)生校園網(wǎng) 努力打造的學(xué)生最實用的網(wǎng)絡(luò)平臺！ 更多精彩，盡在大學(xué)生校園網(wǎng) 9 附錄 A 軟件需求分析報告文檔模板 1. 引言 ............................................................................................................................................................11 編寫目的 ..............................................................................