需求分析報(bào)告編寫規(guī)范
需求分析報(bào)告編寫規(guī)范 |文件編號： |生效日期： |受控編號： | |NW503101 |2000.3.20 | | |密級：秘密 |版次：Ver2.1 |修改狀態(tài)： | |總頁數(shù) |16 |正文 |4 |附錄 |12 | |編制：楊利 |審核：袁淮 |批準(zhǔn)：孟莉 | 沈陽東大阿爾派軟件股份有限公司 （版權(quán)所有，翻版必究） 文件修改控制 |修改記錄編號 |修改 |修改頁碼及條款 |修改人|審核人|批準(zhǔn)人|修改日期 | | |狀態(tài) | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 目錄 1. 目的 2. 適用范圍 3. 術(shù)語及縮略語 4. 編寫規(guī)范 4.1 排版規(guī)范 4.2 模板使用 5. 引用文件 5.1 NW503102《軟件功能規(guī)格說明書編寫規(guī)范》 6. 附錄 目的 為使需求分析的結(jié)果能夠完整、無遺漏地反映待開發(fā)系統(tǒng)的要求，本文件規(guī)定《需求 分析報(bào)告》的編寫格式和內(nèi)容要求。 適用范圍 適用于本公司軟件產(chǎn)品或軟件項(xiàng)目的需求分析報(bào)告的編制。 術(shù)語及縮略語 本程序采用NQ402100《質(zhì)量手冊》中的術(shù)語和縮略語及其定義。 編寫規(guī)范 4.1 排版規(guī)范 1. 整個(gè)規(guī)范由2節(jié)構(gòu)成，模板單獨(dú)一節(jié)。 2. 正文樣式采用“規(guī)范正文”。 3. 標(biāo)題編號采用每節(jié)獨(dú)立編號。 4.2 模板使用 需求分析報(bào)告的編寫可依據(jù)具體情況選用摸板的格式或編寫指南的格式。 1. 拷貝規(guī)范。 2. 刪除第一節(jié)（需求分析報(bào)告封面前的所有頁）。 3. 在修改完內(nèi)容后，更新目錄域和相關(guān)的頁數(shù)域。 引用文件 5.1 NW503102《軟件功能規(guī)格說明書編寫規(guī)范》 附錄 以下部分為需求分析報(bào)告的模板與編寫指南。 密級：機(jī)密 文檔編號： 第 版 分冊名稱： 第 冊/共 冊 項(xiàng)目名稱（項(xiàng)目編號） 需求分析報(bào)告 （部門名稱） 沈陽東大阿爾派軟件股份有限公司 |總頁數(shù)| |正文 | |附錄 | |生效日期： 年 月 日| |編制： |審核： |批準(zhǔn)： | 目錄 1. 引言 1 1.1 編寫目的 1 1.2 背景 1 1.3 參考資料 1 1.4 術(shù)語 1 2. 任務(wù)概述 1 2.1 目標(biāo) 1 2.2 系統(tǒng)（或用戶）的特點(diǎn) 1 3. 假定和約束 2 4. 需求規(guī)定 2 4.1 軟件功能說明 2 4.2 對功能的一般性規(guī)定 2 4.3 對性能的一般性規(guī)定 2 4.4 其他專門要求 2 4.5 對安全性的要求 2 5. 運(yùn)行環(huán)境規(guī)定 2 5.1 設(shè)備及分布 2 5.2 支撐軟件 2 5.3 接口 1 5.4 程序運(yùn)行方式 1 6. 開發(fā)成本估算 1 7. 尚需解決的問題 1 8. 附錄 1 引言 9.1 目的 說明編寫這份報(bào)告的目的，指出預(yù)期的讀者。 9.2 背景 指出待開發(fā)的軟件系統(tǒng)的名稱；行業(yè)情況；本項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶；該 軟件系統(tǒng)同其他系統(tǒng)或其他機(jī)構(gòu)的基本的相互來往關(guān)系。 9.3 參考資料 列出編寫本報(bào)告時(shí)參考的文件(如經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級機(jī)關(guān)的批文等)、 資料、技術(shù)標(biāo)準(zhǔn)，以及他們的作者、標(biāo)題、編號、發(fā)布日期和出版單位。 |編號 |資料名稱 |簡介 |作者 |日期 |出版單位 | | | | | | | | 列出編寫本報(bào)告時(shí)查閱的Intenet上雜志、專業(yè)著作、技術(shù)標(biāo)準(zhǔn)以及他們的網(wǎng)址。 |網(wǎng)點(diǎn) |簡介 | | | | 9.4 術(shù)語 列出本報(bào)告中用到的專門術(shù)語的定義。 任務(wù)概述 10.1 目標(biāo) 敘述該項(xiàng)軟件開發(fā)的意圖、應(yīng)用目標(biāo)、作用范圍以及其他應(yīng)向讀者說明的有關(guān)該軟件 開發(fā)的背景材料。解釋被開發(fā)軟件與其他有關(guān)軟件之間的關(guān)系。如果本軟件產(chǎn)品是一 項(xiàng)獨(dú)立的軟件，而且全部內(nèi)容自含，則說明這一點(diǎn)。如果所定義的產(chǎn)品是一個(gè)更大的 系統(tǒng)的一個(gè)組成部分，則應(yīng)說明本產(chǎn)品與該系統(tǒng)中的其他各組成部分之間的關(guān)系，為 此可使用一張方框圖來說明該系統(tǒng)的組成和本產(chǎn)品同其他各部分的聯(lián)系和接口。 10.2 系統(tǒng)（或用戶）的特點(diǎn) 如果是產(chǎn)品開發(fā)，應(yīng)列出本軟件的特點(diǎn)，與老版本軟件（如果有的話）的不同之處， 與市場上同類軟件（如果有的話）的比較。說明本軟件預(yù)期使用頻度； 如果是針對合同開發(fā)，則應(yīng)列出本軟件的最終用戶的特點(diǎn)，充分說明操作人員、維護(hù) 人員的教育水平和技術(shù)專長，以及本軟件預(yù)期使用頻度。這些是軟件設(shè)計(jì)工作的重要 約束。 假定和約束 列出進(jìn)行本軟件開發(fā)工作的假定和約束，例如經(jīng)費(fèi)限制、開發(fā)期限等。 需求規(guī)定 12.1 軟件功能說明 列出本系統(tǒng)中所有軟件功能子系統(tǒng)和功能。如果子系統(tǒng)比較大，每個(gè)子系統(tǒng)按照NW4 043102《軟件功能規(guī)格說明書編寫規(guī)范》分別編寫軟件功能規(guī)格說明書，在本處列出編 號和分冊名稱。 12.2 對功能的一般性規(guī)定 本處僅列出對軟件系統(tǒng)的所有功能（或一部分）的共同要求，如要求界面格式統(tǒng)一， 統(tǒng)一的錯(cuò)誤聲音提示，要求有在線幫助等。 12.3 對性能的一般性規(guī)定 對數(shù)據(jù)精度、響應(yīng)時(shí)間的要求。本處僅列出對軟件系統(tǒng)的所有功能（或一部分）的共 同要求，針對某一功能的專門性能要求應(yīng)列在該功能規(guī)格說明中。 12.4 其他專門要求 視具體情況，列出不在本規(guī)范規(guī)定中的需求，如對數(shù)據(jù)庫的要求，多平臺(tái)特性要求， 操作特性要求，場合適應(yīng)性要求等對一具體軟件系統(tǒng)的所有功能（或一部分）的共同 要求，針對某一功能的專門要求應(yīng)列在該功能說明中。 12.5 對安全性的要求 指出系統(tǒng)對使用權(quán)限的管理要求（使用權(quán)限分為幾級、是否與部門權(quán)力體系對應(yīng)等） 、信息加密、信息認(rèn)證（確定穿過系統(tǒng)或網(wǎng)絡(luò)的信息沒有被修改）方面的要求。 運(yùn)行環(huán)境規(guī)定 13.1 設(shè)備及分布 1. 主機(jī)類型 2. 網(wǎng)絡(luò)類型 3. 存貯器容量 4. 其他特殊設(shè)備 5. 設(shè)備分布圖 13.2 支撐軟件 1. 操作系統(tǒng) 2. 數(shù)據(jù)庫管理系統(tǒng) 3. 其他支撐軟件 13.3 接口 簡要說明該軟件同其他軟件之間的公共接口、數(shù)據(jù)通信協(xié)議等，如果外部接口僅與某 子功能有關(guān)，該接口說明應(yīng)列在子功能規(guī)格說明書中。 13.4 程序運(yùn)行方式 說明該軟件的運(yùn)行方法。如是部件、還是獨(dú)立運(yùn)行程序、API等。 開發(fā)成本估算 以列表的方式給出各功能規(guī)定所需的開發(fā)人時(shí)和費(fèi)用（如差旅費(fèi)）。 尚需解決的問題 以列表的形式列出在需求分析階段必須解決但尚未解決的問題 附錄 需求分析過程中會(huì)產(chǎn)生各種記錄如調(diào)查表格、業(yè)務(wù)系統(tǒng)單據(jù)等。記錄或報(bào)告的存檔編 號和名稱填寫在下表中。其中類別是記錄的分類，一般有業(yè)務(wù)系統(tǒng)說明書、業(yè)務(wù)系統(tǒng) 數(shù)據(jù)說明書、業(yè)務(wù)系統(tǒng)調(diào)查表、原始數(shù)據(jù)單據(jù)、業(yè)務(wù)系統(tǒng)參考資料。 |編號 |名稱 |類別 | | | | | | | | | 需求說明書編寫指南 1. Objectives 目標(biāo) 闡明需求說明書的標(biāo)準(zhǔn)格式，做為合同和需求分析的結(jié)果。 2. Scope 范圍 適用于指導(dǎo)需求說明書的編寫。 本模板力圖覆蓋所有可能在需求說明書中出現(xiàn)的主題。這樣做的目的是并不是要求每一 個(gè)需求說明書都要包括這里定義的全部章節(jié)，而是提供一個(gè)所有需求說明書都應(yīng)當(dāng)遵循 的框架。一些特殊的章節(jié)應(yīng)當(dāng)提供但不要求有詳細(xì)的說明，只需在說明書中包含下面有 適當(dāng)文字說明的標(biāo)題即可，例如，不適用。 3. References 參考 4. Outstanding Issues 尚存主要問題 5. Approvals 批準(zhǔn) 銷售主管 6. Responsibilities 職責(zé) 客戶經(jīng)理有責(zé)任確認(rèn)本模板被切實(shí)執(zhí)行。 7. Template 模板 Lead-in sections 引導(dǎo)部分 7.1.1 以下是需求說明書的起始部分。在文檔格式規(guī)范中有關(guān)于它們的更詳細(xì)的描述。 1）Objectives目標(biāo) 2）Scope范圍 3）References參考 4）Assumptions前題條件 5）Outstanding Issues尚存主要問題 6）Document Control文檔控制 7）Approvals批準(zhǔn) 8）Distribution分發(fā) 9）Amendment Record更改記錄 10）Traceability可追溯 7.2 Component or System Description 部件或系統(tǒng)描述 本說明書所覆蓋的部件或系統(tǒng)的簡要介紹。本部分可以很簡要，因?yàn)樗鼉H包含幫助讀者 快速了解所說明內(nèi)容的信息。 應(yīng)當(dāng)提供一個(gè)上下文相關(guān)圖來幫助確定被描述的部件或系統(tǒng)的定位。使用USER- CASE圖來描述。 參考應(yīng)當(dāng)做成關(guān)聯(lián)文檔（例如建議，合同，項(xiàng)目編號）。 7.3 Purchaser Requirements 客戶需求 7.3.1 Summary 概要 7.3.1.1 本部分應(yīng)當(dāng)包括那些直接影響到客戶使用本部件或系統(tǒng)的需求。它分為兩個(gè)部 分，功能和特性。 o 部件或系統(tǒng)的功能描述了什么可以做，例如，打印一個(gè)報(bào)表。 o 部件或系統(tǒng)的特性提供了那些可以描述和評價(jià)系統(tǒng)質(zhì)量的屬性。 7.3.1.2 每個(gè)段落（或段落組）應(yīng)當(dāng)包含一個(gè)參考來跟蹤需求的出處。每個(gè)句子或段落 應(yīng)當(dāng)編號；無論何種情況每個(gè)編號的項(xiàng)目僅應(yīng)當(dāng)定義一個(gè)需求。 7.3.1.3 每個(gè)段落（或段落組）應(yīng)當(dāng)指出它的重要程度，按以下方式分類： 1）強(qiáng)制的：最基本的特征；沒有它產(chǎn)品將不可用。 2）必需的：單獨(dú)的非基本的特征，但是它們加在一起會(huì)影響產(chǎn)品的能力。 3）期待的：最好能有的特征；一個(gè)或多個(gè)這些特征被忽略也不會(huì)影響產(chǎn)品的 能力。 7.3.2 Purchaser-Related Functionality 客戶要求的功能 7.3.2.1 Application Functionality 應(yīng)用程序的功能 7.3.2.1.1 在系統(tǒng)或子系統(tǒng)一級，這一部分應(yīng)當(dāng)包含可用的應(yīng)用程序所提供的功能的描述。 7.3.2.1.2 在應(yīng)用程序一級，這一部分細(xì)化應(yīng)用程序必須做到的功能。 7.3.2.1.3 功能應(yīng)當(dāng)用結(jié)構(gòu)化的英語或適當(dāng)?shù)男问交姆椒▽W(xué)來描述。 7.3.2.2 Human Interface 人機(jī)界面 7.3.2.2.1 這一部分應(yīng)當(dāng)定義所需的菜單結(jié)構(gòu)，屏幕/窗口設(shè)計(jì)，報(bào)表設(shè)計(jì)和其它操作/或 管理界面。在這一過程中，需求可能廣泛地涉及已有的標(biāo)準(zhǔn)或產(chǎn)品。 7.3.2.2.2 參考應(yīng)當(dāng)指向其它的說明書和標(biāo)準(zhǔn)。 7.3.2.3 Data Types 數(shù)據(jù)類型 這一部分應(yīng)當(dāng)包括對系統(tǒng)或應(yīng)用程序中對用戶有用的所有數(shù)據(jù)類型的描述，包括應(yīng) 用程序開發(fā)工具用到的或表單，顯示，報(bào)表和輸出用到的。 7.3.2.4 Control Structures 控制結(jié)構(gòu) 這一部分應(yīng)當(dāng)描述系統(tǒng)或應(yīng)用程序的控制結(jié)構(gòu)。 7.3.2.5 Application Development Environment 應(yīng)用開發(fā)環(huán)境 這部分應(yīng)當(dāng)指定可供用戶用來開發(fā)應(yīng)用程序的系統(tǒng)部件。它應(yīng)當(dāng)至少包含數(shù)據(jù) 類型和語言或者可用的應(yīng)用程序生成器。 7.3.2.6 Hardware 硬件 這部分應(yīng)當(dāng)詳細(xì)說明根據(jù)用戶需要提出的硬件需求。 7.3.2.7 Software 軟件 本節(jié)將詳細(xì)說明因?yàn)橛脩粜枰a(chǎn)生的軟件需求。如果用戶已經(jīng)提供了面向系 統(tǒng)或部件或與系統(tǒng)或部件合為一體的產(chǎn)品，那么這些應(yīng)當(dāng)在需求和所有設(shè)想以 及需求文檔中清晰的定義出來。這些需求可能包括下列各項(xiàng)： 1） Operating System 操作系統(tǒng) 2） Database 數(shù)據(jù)庫 3） Communications 通信 4） Interfaces 接口 7.3.3 Purchaser-Related Characteristics 客戶相關(guān)的特征 在多數(shù)情況下，用戶會(huì)指定一些如下的特性。如果它們能夠增強(qiáng)系統(tǒng)的能力則應(yīng)當(dāng) 被包含進(jìn)來，另一種選擇是在最開始的時(shí)候就對某些特性進(jìn)行限定以避免驗(yàn)收 測試時(shí)無休止的爭論。如果一些特性沒有在本部分被指定，它們應(yīng)當(dāng)在公司需 求部分被指定，舉例來說很多特性關(guān)系到系統(tǒng)投入使用后公司的技術(shù)支持成本 。 7.3.3.1 Pre-operational 運(yùn)行之前 7.3.3.1.1 Packaging 包裝 7.3.3.1.2 Installation 安裝 7.3.3.1.3 Configuration 配置 7.3.3.2 Functionality 功能 7.3.3.2.1 Suitability 適用性 7.3.3.2.2 Accuracy 精確性 7.3.3.2.3 Interoperability 協(xié)同工作能力 7.3.3.2.4 Compliance – standards 遵循標(biāo)準(zhǔn) 7.3.3.2.5 Security 安全性 7.3.3.3 Reliability 可靠性 7.3.3.3.1 Maturity 完備性 7.3....
需求分析報(bào)告編寫規(guī)范