軟件開發(fā)文檔模板

1、軟件開發(fā)文檔模板附錄A軟件需求分析報告文檔模板附錄B軟件概要設(shè)計報告文檔模板附錄C軟件詳細設(shè)計報告文檔模板附錄D軟件數(shù)據(jù)庫設(shè)計報告文檔模板附錄E軟件測試（驗收）大綱4目錄111. 范圍2. 總體要求2.1總體功能要求2.2軟件開發(fā)平臺要求 2.3軟件項目的開發(fā)實施過程管理要求2.3.1軟件項目實施過程總體要求56662.3.2軟件項目實施變更要求.2.3.3軟件項目實施里程碑控制3. 軟件開發(fā)3.1軟件的需求分析3.1.1需求分析 3.1.2 需求分析報告的編制者3.1.3需求報告評審3.1.4需求報告格式'3.2軟件的概要設(shè)計3.2.1概要設(shè)計3.2.2編寫概要設(shè)計的要求3.2.3概

2、要設(shè)計報告的編寫者 3.2.4概要設(shè)計和需求分析、詳細設(shè)計之間的關(guān)系和區(qū)別3.2.5概要設(shè)計的評審 3.2.6概要設(shè)計格式3.3軟件的詳細設(shè)計3.3.1詳細設(shè)計3.3.2特例3.3.3詳細設(shè)計的要求 3.3.4數(shù)據(jù)庫設(shè)計.3.3.5詳細設(shè)計的評審3.3.6詳細設(shè)計格式.3.4軟件的編碼3.4.1軟件編碼3.4.2軟件編碼的要求3.4.3編碼的評審.3.4.4編程規(guī)范及要求3.5軟件的測試.3.5.1軟件測試3.5.2測試計劃3.6軟件的交付準備3.6.1交付清單3.7軟件的鑒定驗收101010101010103.7.1軟件的鑒定驗收3.7.2驗收人員3.7.3驗收具體內(nèi)容.1111113.7.

3、4軟件驗收測試大綱3.8培訓(xùn)3.8.1系統(tǒng)應(yīng)用培訓(xùn)3.8.2系統(tǒng)管理的培訓(xùn)（可選）111.范圍本指南用于指導(dǎo)軟件開發(fā)者為南京市交通局開發(fā)軟件項目的過程，通過規(guī)范軟件項目承擔單位的開發(fā)過程達到提高軟件質(zhì)量，降低維護成本的目的。開發(fā)者應(yīng)根據(jù)本指南進行軟件開發(fā)和編制軟件開發(fā)文檔。本指南是對軟件項目承擔單位的基本要求。在本指南的附錄A至E中提供了文檔的編寫模板供開發(fā)者參考，在進行具體軟件開發(fā)時，開發(fā)者可根據(jù)實際情況采編寫，但必須提供雙方約定的文檔,文檔中約定的內(nèi)容必須描述清楚。2. 總體要求2.1總體功能要求 網(wǎng)絡(luò)應(yīng)用環(huán)境以Internet/Intranet技術(shù)為核心。開發(fā)者應(yīng)在充分分析需求的基礎(chǔ)上，

4、選擇采用B/S結(jié)構(gòu)或者C/S結(jié)構(gòu)。軟件系統(tǒng)的數(shù)據(jù)庫應(yīng)依照南京市交通局信息化數(shù)據(jù)庫建設(shè)規(guī)范進行設(shè)計和建 設(shè)。本指南中沒有規(guī)定開發(fā)者采用何種具體的軟件工程開發(fā)方法， 開發(fā)者可根據(jù)項目 具體特點、自身擅長來選擇采用面向過程的方法、 面向?qū)ο蟮姆椒ɑ蛎嫦驍?shù)據(jù)的 方法，但建議開發(fā) 商使用面向?qū)ο筌浖こ痰姆椒?，女口：采用目前被廣泛使用 的RUP（Rational Unified Process方法來進行分析、設(shè)計和開發(fā)。2.2軟件開發(fā)平臺要求開發(fā)者開發(fā)的軟件必須能夠在南京市交通局規(guī)定的軟件平臺上正常運行。目前軟.件平臺為：數(shù)據(jù)庫管理系統(tǒng)：Oracle 9i以上版本 中間件（應(yīng)用服務(wù)器）系統(tǒng):IBM We

5、bS phereOA系統(tǒng)：Lotus Domino /NoteS 網(wǎng)絡(luò)架構(gòu)：.完全支持TCP/IP協(xié)議 開發(fā)工具或技術(shù)體系:為保證軟件的上下兼容性，開發(fā)者應(yīng)選擇比較通用的開發(fā)工具的較新版本進行開發(fā)，如 Microsoft Visual Studio.Net， Borla nd Del phi，C+ Builder,或J2EE(Java2 Platform En terprise Edition等。2.3軟件項目的開發(fā)實施過程管理要求 2.3.1軟件項目實施過程總體要求（一）開發(fā)者提交軟件開發(fā)工作大綱，交通局組織專家組對工作大綱進行 評審，并提出整改意見。（二）通過評審后，開發(fā)者根據(jù)整改意見完善

6、工作大綱，經(jīng)過交通局認可 后組織項目組進行軟件開發(fā)。軟件開發(fā)工作按照需求分析、概要設(shè)計、詳 細設(shè)計、編碼、測試等幾個階段進行，在開發(fā)過程中，開發(fā)者需分階段提 交相關(guān)文檔。（二）在軟件開發(fā)工作完成后，開發(fā)者應(yīng)向交通局提交完整的軟件文檔， 交通局組織驗收組對軟件進行驗收審查。2.3.2軟件項目實施變更要求在開發(fā)過程中，需求或設(shè)計不可避免地需要發(fā)生變更，相關(guān)變更必須經(jīng)過交通局 書面同 意方可進行。在需求或設(shè)計發(fā)生變更時，需要對原有文檔進行修改， 提供完整的變更記錄， 以使變更處于可控制的狀態(tài)。變更單如下表所示：表2-1變更單需求變更申請申請變更的需求文檔輸入名稱，版本，日期等信息變更的內(nèi)客及其理由評

7、估需求變更將對 項目造成的影響申請人簽字變更申請的審批意見項目經(jīng)理簽字審批意見：簽字日期客戶簽字 （合同項目）審批意見：簽字日期更改需求文檔變更后的 需求文檔輸入名稱，版本，完成日期等信息更改人簽字重新評審需求文檔需求評審小組簽字評審意見：'1簽字日期變更結(jié)束項目經(jīng)理簽字1簽字日期2.3.3軟件項目實施里程碑控制交通局將分四個階段進行把關(guān)，召開專家審查會。:（一）需求分析（結(jié)合原型進行審查）確認;:（二）概要設(shè)計+數(shù)據(jù)庫設(shè)計；（三）預(yù)驗收（試運行后）；（四）正式驗收（推廣使用后）。3. 軟件開發(fā)合同簽訂以后，項目承擔單位即可組織項目組進行軟件開發(fā)工作。 軟件開發(fā)必須 嚴格按照軟件工程的

8、要求進行。開發(fā)過程包括開發(fā)者的活動和任務(wù)。此過程碩 件需求分析、概要設(shè)計、詳細設(shè)計、編碼、測試、驗收、鑒定等活動組成。 一 3.1軟件的需求分析 3.1.1需求分析首先，開發(fā)者和交通局應(yīng)共同對交通局的應(yīng)用需求作充分的調(diào)研，提交完整的需求分析 報告。在需求分析報告中必須描述的基本問題是：功能、性能、強加廠= 實現(xiàn)的設(shè)計限制、屬 性、外部接口。應(yīng)當避免把設(shè)計或項目需求寫入需求分析 報告中。它必須說明由軟件獲得的 結(jié)果，而不是獲得這些結(jié)果的手段。軟件需求可以用若干種方法來表達，如通過輸入、輸出說明；使用代表性的例子； 用規(guī)范化的模型。開發(fā)者應(yīng)盡可能地使用模型的方式,因為這是表達復(fù)雜需求的 精確和有效

9、的方法。比如用統(tǒng)一建模語言（UML ）來描述需求。編寫需求分析報告的要求 a無歧義性 對最終產(chǎn)品的每一個特性用某一術(shù)語描述；若某一術(shù)語在某一特殊的行文中使用 時具有多種含義，那么應(yīng)對該術(shù)語的每種含義做出解釋并指出其適用場合。b完整性 需求分析報告應(yīng)該包括全部有意義的需求， 無論是關(guān)系到功能的、性能的、設(shè)計 約束的、還是關(guān)系到外部接口方面的需求； 對所有可能出現(xiàn)的輸入數(shù)據(jù)的響應(yīng)予. 以定義，要對合法和非合法的輸入值的響應(yīng)做出規(guī)定；填寫全部插圖、表、圖示 ， 標記等；定義全部術(shù)語和度量單位。C 可驗證性 需求分析報告描述的每一個需求應(yīng)是可以驗證的。 可以通過一個有限處理過程來 檢查軟件產(chǎn)品是否滿足

10、需求。d. 致性 在需求分析報告中的各個需求的描述不能互相矛盾。e可修改性 需求分析報告應(yīng)具有一個有條不紊、 易于使用的內(nèi)容組織；沒有冗余，即同一需 求不能在需求分析報告中出現(xiàn)多 f.可追蹤性 每一個需求的源流必須清晰，在進一步產(chǎn)生和改變文件編制時，可以方便地引證 每一個需求。g.運行和維護階段的可使用性需求分析報告必須滿足運行和維護階段的需要。在需求分析報告要寫明功能的來源和目的。3.1.2需求分析報告的編制者需求分析報告應(yīng)由交通局和開發(fā)者雙方共同完成。其中：交通局負責根據(jù)實際需 要提出希望軟件實現(xiàn)的功能；軟件開發(fā)者根據(jù)交通局提出的性能需求,結(jié)合軟件 開發(fā)編寫需求分析。3.1.3需求報告評審

11、在軟件需求分析工作完成后，軟件開發(fā)者應(yīng)向交通局提交軟件需求分析報告。交通局組織有關(guān)人員對需求進行評審，以決定軟件需求是否完善和恰當。評審?fù)瓿珊?，就可以進入軟件的設(shè)計階段。3.1.4需求報告格式軟件需求分析報告需按一定的格式進行編寫，具體的軟件需求分析報告 文檔編寫模板請見附錄 A。3.2軟件的概要設(shè)計 3.2.1概要設(shè)計在交通局和開發(fā)者雙方認可的需求分析報告基礎(chǔ)上，開發(fā)者進行下工作。止的 首先，開發(fā)者需要對軟件系統(tǒng)進行概要設(shè)計，即系統(tǒng)設(shè)計。概要設(shè)計需要對軟件系統(tǒng)的設(shè)計進行考慮，包括系統(tǒng)的基本處理流程、系統(tǒng)的組織結(jié)構(gòu)、模塊劃分、功能分配、接口設(shè)計、運行設(shè)計、數(shù)據(jù)結(jié)構(gòu)設(shè)計和出錯處理設(shè)計等， 為軟件

12、的詳細設(shè)計提供基礎(chǔ)。3.2.2編寫概要設(shè)計的要求a. 致性概要設(shè)計的要求應(yīng)該與需求分析報告所描述的需求一致。同時，概要設(shè)計的各項 要求之間也應(yīng)該一致。b合理性 概要設(shè)計所提出的設(shè)計方法和標準應(yīng)該是合理的、恰當?shù)摹可追蹤性對概要設(shè)計所提出的各項要求應(yīng)該可以得到它的清晰的源流，即在需求分析報告 客戶有明確的需求描述。d可行性 根據(jù)概要設(shè)計進行詳細設(shè)計、操作和維護應(yīng)該是可行的。3.2.3概要設(shè)計報告的編寫肘概要設(shè)計報告由開發(fā)者根據(jù)需求分析報告的要求進行編寫。3.2.4概要設(shè)計和需求分析、詳細設(shè)計之間的關(guān)系和區(qū)別需求分析不涉及具體的技術(shù)實現(xiàn)，而概要設(shè)計注重于從宏觀上和框架上來描述 采用何種技術(shù)手段、

13、方法來實現(xiàn)這些需求。詳細設(shè)計相對概要設(shè)計更注重于微觀 上和框架內(nèi)的設(shè)計，是編碼的依據(jù)。概要設(shè)計是指導(dǎo)詳細設(shè)計的依據(jù)。3.2.5概要設(shè)計的評審 在軟件概要設(shè)計工作完成后，軟件開發(fā)者應(yīng)向交通提交軟件系統(tǒng)概要設(shè)計報 告。在交通局對概要設(shè)計報告評審?fù)ㄟ^后，即可進入詳細設(shè)計階段。 3.2.6概要設(shè)計格式軟件系統(tǒng)概要設(shè)計報告需按一定的格式進行編寫，具體的軟件系統(tǒng)概要設(shè) 計報告文檔編寫模板請見附錄B。3.3軟件的詳細設(shè)計 3.3.1詳細設(shè)計 在概要設(shè)計的基礎(chǔ)上，開發(fā)者需要進行軟件系統(tǒng)的詳細設(shè)計。 在詳細設(shè)計中，描 述實 現(xiàn)具體模塊所涉及到的主要算法、數(shù)據(jù)結(jié)構(gòu)、類的層次結(jié)構(gòu)及調(diào)用關(guān)系，一 需要說明軟件系統(tǒng)各個

14、層次中的每一個程序（每個模塊或子程序）的設(shè)計考慮E 便進行編碼和測試。應(yīng)當保證 軟件的需求完全分配給整個軟件。 詳細設(shè)計應(yīng)當 足夠詳細，能夠根據(jù)詳細設(shè)計報告進行編碼。3.3.2特例如果軟件系統(tǒng)比較簡單，層次較少，可以不必進行專門的詳細設(shè)計， 而和概要設(shè) 計結(jié)合起來。3.3.3詳細設(shè)計的要求a. 致性詳細設(shè)計的要求應(yīng)該與需求分析報告所描述的需求、與概要設(shè)計一致。同時，詳 細設(shè)計的各項要求之間也應(yīng)該是一致的。b合理性詳細設(shè)計所提出的設(shè)計方法和標準應(yīng)該是合理的、恰當?shù)?。C可追蹤性對詳細設(shè)計所提出的各項要求應(yīng)該可以得到它的清晰的源流，即可在需求分析報告、概要設(shè)計報告中有明確的需求描述。d可行性 根據(jù)詳

15、細設(shè)計進行編碼、測試、操作和維護應(yīng)該是可行的。3.3.4數(shù)據(jù)庫設(shè)計如果軟件產(chǎn)品需要使用到數(shù)據(jù)庫，軟件的詳細設(shè)計應(yīng)包括對數(shù)據(jù)庫的設(shè)計。 數(shù)據(jù) 庫設(shè)計應(yīng)在軟件的需求分析、概要設(shè)計完成之后、詳細設(shè)計的其它工作之前進行。 在進行數(shù)據(jù)庫設(shè)計時，應(yīng)當按照交通局制定的南京市交通局信息化數(shù)據(jù)庫建設(shè)" 規(guī)范要求進行。3.3.5詳細設(shè)計的評審在軟件詳細設(shè)計完成后，軟件開發(fā)者應(yīng)向交通局提交軟件系統(tǒng)數(shù)據(jù)庫設(shè)計報告 和軟件系統(tǒng)詳細設(shè)計報告。在交通局對軟件系統(tǒng)數(shù)據(jù)庫設(shè)計報告、軟 件系統(tǒng)詳細設(shè)計報告評審?fù)ㄟ^后，即可進入軟件編碼階段。3.3.6詳細設(shè)計格式軟件系統(tǒng)詳細設(shè)計報告、軟件系統(tǒng)數(shù)據(jù)庫設(shè)計報告需按一定的格式進

16、行 編寫具體的軟件系統(tǒng)詳細設(shè)計報告文檔編寫模板和軟件系統(tǒng)數(shù)據(jù)庫設(shè) 計報告文檔編寫模 板請見附錄C、附錄D。3.4軟件的編碼 3.4.1軟件編碼 在軟件編碼階段，開發(fā)者根據(jù)軟件系統(tǒng)詳細設(shè)計報告中對數(shù)據(jù)結(jié)構(gòu)、算法分 析和模塊實現(xiàn)等方面的設(shè)計要求， 開始具體的編寫程序工作，分別實現(xiàn)各模塊的 功能，從而實現(xiàn)對目標系統(tǒng)的功能、性能、接口、界面等方面的要求。3.4.2軟件編碼的要求 a模塊化編碼 b代碼可讀性C 可維護性d. 模塊接口標準化e. 界面風格統(tǒng)一e.注釋的應(yīng)用3.4.3編碼的評審為了盡早發(fā)現(xiàn)軟件中的障礙，提高軟件產(chǎn)品的質(zhì)量，開發(fā)者在編碼的過程中應(yīng)該 強調(diào)代碼評審工作。將代碼評審報告作為文檔的一

17、部分，提交給交通局。3.4.4編程規(guī)范及要求為了提高編程實現(xiàn)的質(zhì)量，軟件的程序設(shè)計必須遵照國家頒布的相關(guān)編程規(guī)范。主要內(nèi)容包括：規(guī)范化的程序內(nèi)部文檔、數(shù)據(jù)結(jié)構(gòu)的詳細說明、清晰的語句結(jié)構(gòu)、 編碼規(guī)范。編碼規(guī)范的內(nèi)容包括命名規(guī)范、界面規(guī)范、提示及幫助信息規(guī)范、熱 鍵定義等。其中數(shù)據(jù)庫部分應(yīng)遵守南京市交通局信息化數(shù)據(jù)庫建設(shè)規(guī)范的要求。在軟件編碼的同時應(yīng)進行單元測試。3.5軟件的測試3.5.1軟件測試為了盡早發(fā)現(xiàn)軟件產(chǎn)品中的錯誤，從而達到提高軟件質(zhì)量、降低軟件維護的費用， 開發(fā)者應(yīng)在編碼過程中對各個模塊的程序代碼進行單元測試，系統(tǒng)集成時進行集成測試，系統(tǒng)集成完成后對整個軟件進行系統(tǒng)測試。單元測試是在軟

18、件開發(fā)過君 中針對程序模塊進行正確性檢驗。集成測試是在單元測試的基礎(chǔ)上，將所有模塊 按照設(shè)計要求組裝成系統(tǒng)或子系統(tǒng)，對模塊組裝過程和模塊接口進行正確性檢 驗。軟件系統(tǒng)測試不僅是檢測軟件的整體行為表現(xiàn)，從另一個側(cè)面看，也是對軟件開發(fā)設(shè)計的再確認。進行軟件系統(tǒng)測試工作時。測試主要包括界面測試、可 用性測試、功能測試、穩(wěn)定性（強度）測試、性能測試、強壯性（恢復(fù)）測試、邏輯 性測試、破壞性測試、安全性測試等。開發(fā)者針對單元測試，集成測試，系統(tǒng)測試分別制定測試計劃。集成測試需 要根據(jù)需求分析報告和概要設(shè)計制作測試用例,并須經(jīng)過評審。軟件測試按照測 試計劃、需求分析報告的要求進行，最后形成軟件測試報告。3

19、.5.2測試計劃在軟件編碼開始之前，開發(fā)者應(yīng)向交通局提交測試計劃，在軟件交付時，開 發(fā)者應(yīng)向交通局提交軟件測試報告，以確保開發(fā)者的軟件得到了充分的測試。 開發(fā)的軟件必須經(jīng)過充分的測試證明其符合設(shè)計要求、運行穩(wěn)定、安全可用方可 交付交通局。3.6軟件的交付準備 3.6.1交付清單 在軟件測試證明軟件達到要求后，軟件開發(fā)者應(yīng)向交通局提交開發(fā)的目標安裝程 序、數(shù)據(jù)庫的數(shù)據(jù)字典、用戶安裝手冊、用戶使用指南、需求報告、設(shè) 計報告、測試報告等雙方合同約定的產(chǎn)物。用戶安裝手冊應(yīng)詳細介紹安裝軟件對運行環(huán)境的要求、安裝軟件的定義和內(nèi) 容、在客戶端、服務(wù)器端及中間件的具體安裝步驟、安裝后的系統(tǒng)配置。用戶使用指南應(yīng)包括軟件各項功能的使用流程、操作步驟、相應(yīng)業(yè)務(wù)介紹、 特殊提示和注意事項等方面的內(nèi)容，在需要時還應(yīng)舉例說明。3.7軟件的鑒定驗收 3.7.1軟件的鑒定驗收 在軟件開發(fā)完成后，為了確保軟件是按照需求分析的要求進行開發(fā)的， 保證軟件 產(chǎn)品的質(zhì)量，需要對軟件產(chǎn)品進行鑒定驗收。 在開發(fā)者如期交付軟件后，由交通 局負責確定具體的鑒定驗收日期。3.7.2驗收人員 由交通局聘請具有一定的分析、 設(shè)計、編程和軟件測試經(jīng)驗的驗收組長和其他專 業(yè)人員組成。驗收組設(shè)組長一名（可設(shè)有副組長），負責整個驗收的