【正文】 模版集萃 綜述： 在程序員的日常工作中，除了編 寫代碼之外，還免不了需要編寫各種技術(shù)文檔。 一個(gè)編寫良好的技術(shù)文檔在項(xiàng)目中 能夠很好地建立溝通與協(xié)作，起到很積極的作用。因此，編寫技術(shù)文檔也就成為了程序員技能提升的很重要的一面。 為此，我們特意收集了一些在項(xiàng)目開發(fā)過程中經(jīng)常用到的文檔模板，這些模板包括格式和簡單的寫作說明，相信能夠幫助大家編寫出更加高效、實(shí)用的技術(shù)文檔。 在收集過程中，我們十分注重其實(shí)用性，以確保每個(gè)模板的價(jià)值 ，而且對于一些 重要的文檔提供了多個(gè)模板 。 為了方便大家查找，我們將收錄的 57 模板分為以下 幾類： 1） 項(xiàng)目及開發(fā)管理類：包括立項(xiàng)前的分析 ， 立項(xiàng) 后 的計(jì)劃、 以及進(jìn)度跟蹤、風(fēng)險(xiǎn)控制方面的文檔模板，共計(jì) 16 個(gè)； 2） 需求分析類：明確清晰的需求，是項(xiàng)目成功的基礎(chǔ)，在此收集了在需求分析過程中所將使用到的文檔模板，共計(jì) 14 個(gè)； 3） 系統(tǒng)分析與設(shè)計(jì) 類 ：包括體系結(jié)構(gòu) 設(shè)計(jì) 、高層設(shè)計(jì)、 詳細(xì)設(shè)計(jì)、數(shù)據(jù)庫設(shè)計(jì)等 6個(gè)相關(guān)文檔模板； 4） 軟件質(zhì)量保證 類 ：軟件測試是質(zhì)量保證的關(guān)鍵活動(dòng)，在此收集了軟件測試相關(guān)的11 個(gè)文檔模板； 5） 其它 類 ： 除此之外，還收集了關(guān)于用戶手冊、軟件維護(hù)等方面的 10 個(gè)文檔模板，其中還有一個(gè)軟件過程規(guī)范的示例。 另外，值得說 明的是，文檔 模板只是為文檔的編寫提供一個(gè)基礎(chǔ)，在實(shí)際的編寫過程中，你可以根據(jù)自己的需要進(jìn)行必要的剪裁和增補(bǔ)。 一、 項(xiàng)目及開發(fā)管理類 可行性研究報(bào)告 (ISO 標(biāo)準(zhǔn) ) 編者說明： 在立項(xiàng)時(shí)，應(yīng)該對項(xiàng)目進(jìn)行綜合分析，探討項(xiàng)目的經(jīng)濟(jì)、社會(huì)、技術(shù)可行性， 從而為決策提供基礎(chǔ)。該模板為 ISO 標(biāo)準(zhǔn)文檔模板， 其不僅適用于軟件項(xiàng)目，對于其它的系統(tǒng)項(xiàng)目也適用。 1. 引言 編寫目的 [編寫本可行性研究報(bào)告的目的，指出預(yù)期的讀者。 ] 背景 a.[所建議開發(fā)的軟件系統(tǒng)的名稱； ] b.[本項(xiàng)目的任務(wù)提出者、開發(fā)者、 用戶及實(shí)現(xiàn)該軟件的計(jì)算站或計(jì)算機(jī)網(wǎng)絡(luò)； ] c.[該軟件系統(tǒng)同其他系統(tǒng)或其他機(jī)構(gòu)的基本的相互來往關(guān)系。 ] 定義 [列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。 ] 參考資料 [列出用得著的參考資料。 ] 2. 可行性研究的前提 [說明對所建議開發(fā)的軟件的項(xiàng)目進(jìn)行可行性研究的前提。 ] 要求 [說明對所建議開發(fā)的軟件的基本要求。 ] 目標(biāo) [說明所建議系統(tǒng)的主要開發(fā)目標(biāo)。 ] 條件、假定和 限制 [說明對這項(xiàng)開發(fā)中給出的條件、假定和所受到期的限制。 ] 進(jìn)行可行性研究的方法 [說明這項(xiàng)可行性研究將是如何進(jìn)行的，所建議的系統(tǒng)將是如何評價(jià)的，摘要說明所使用的基本方法和策略。 ] 評價(jià)尺度 [說明對系統(tǒng)進(jìn)行評價(jià)時(shí)所使用的主要尺度。 ] 3. 對現(xiàn)有系統(tǒng)的分析 [這里的現(xiàn)有系統(tǒng)是指當(dāng)前實(shí)際使用的系統(tǒng)，這個(gè)系統(tǒng)可能是計(jì)算機(jī)系統(tǒng)，也可能是一個(gè)機(jī)械系統(tǒng)甚至是一個(gè)人工系統(tǒng)。 ] [分析現(xiàn)有系統(tǒng)的目的是為了進(jìn)一步闡明建議中的開發(fā)新系統(tǒng)或修改現(xiàn)有系統(tǒng)的必要性 。 ] 處理流程和數(shù)據(jù)流程 [說明現(xiàn)有系統(tǒng)的基本的處理流程和數(shù)據(jù)流程。此流程可用圖表即流程圖的形式表示，并加以敘述。 ] 工作負(fù)荷 [列出現(xiàn)有系統(tǒng)所承擔(dān)的工作及工作量。 ] 費(fèi)用開支 [列出由于運(yùn)行現(xiàn)有系統(tǒng)所引起的費(fèi)用開支。 ] 人員 [列出為了現(xiàn)有系統(tǒng)的運(yùn)行和維護(hù)所需要的人員的專業(yè)技術(shù)類別和數(shù)量。 ] 設(shè)備 [列出現(xiàn)有系統(tǒng)所使用的各種設(shè)備。 ] 局限性 [列出本系統(tǒng)的主要局限性。 ] 4. 所 建議的系統(tǒng) 對所建議系統(tǒng)的說明 [概括地說明所建議系統(tǒng)，并說明在第 2 條中列出的那些要求將如何得到滿足，說明所使用的基本方法及理論根據(jù)。 ] 處理流程和數(shù)據(jù)流程。 [給出所建議系統(tǒng)的處理流程式和數(shù)據(jù)流程。 ] 改進(jìn)之處 [按 條中列出的目標(biāo)，逐項(xiàng)說明所建議系統(tǒng)相對于現(xiàn)存系統(tǒng)具有的改進(jìn)。 ] 影響 [說明新提出的設(shè)備要求及對現(xiàn)存系統(tǒng)中尚可使用的設(shè)備須作出的修改。 ] [說明新提出的設(shè)備要求及對現(xiàn)存系統(tǒng)中 尚可使用的設(shè)備須作出的修改 ] [說明為了使現(xiàn)存的應(yīng)用軟件和支持軟件能夠同所建議系統(tǒng)相適應(yīng)，而需要對這些軟件所進(jìn)行的修改和補(bǔ)充。 ] [說明為了建立和運(yùn)行所建議系統(tǒng)，對用戶單位機(jī)構(gòu)、人員的數(shù)量和技術(shù)水平等方面的全部要求。 ] [說明所建議系統(tǒng)對運(yùn)行過程的影響。 ] [說明對開發(fā)的影響。 ] [說明對建筑物改造的要求及對環(huán)境設(shè)施的 要求。 ] [扼要說明為了所建議系統(tǒng)的開發(fā)，統(tǒng)計(jì)和維持運(yùn)行而需要的各項(xiàng)經(jīng)費(fèi)開支。 ] 技術(shù)條件方面的可能性 [本節(jié)應(yīng)說明技術(shù)條件方面的可能性 ] 5. 可選擇的其他系統(tǒng)方案 [扼要說明曾考慮過的每一種可選擇的系統(tǒng)方案，包括需開發(fā)的和可從國內(nèi)國外直接購買的，如果沒有供選擇的系統(tǒng)方案可考慮，則說明這一點(diǎn)。 ] 可選擇的系統(tǒng)方案 1 [說明可選擇的系統(tǒng)方案 1，并說明它末被選中的理由。 ] 可選擇的系統(tǒng)方案 2 [按類似 5。 1 條 的方式說明第 2 個(gè)乃至第 n 個(gè)可選擇的系統(tǒng)方案。 ] [?? ] 6. 投資及效益分析 支出 [對于所選擇的方案，說明所需的費(fèi)用，如果已有一個(gè)現(xiàn)存系統(tǒng)，則包括該系統(tǒng)繼續(xù)運(yùn)行期間所需的費(fèi)用。 ] 基本建設(shè)投資 [包括采購、開發(fā)和安裝所需的費(fèi)用。 ] 其他一次性支出 非一次性支出 [列出在該系統(tǒng)生命期內(nèi)按月或按季或按年支出的用于運(yùn)行和維護(hù)的費(fèi)用。 ] 收益 [對于所選擇的方案，說明能夠帶來的收益，這里所說的收益，表現(xiàn)為開支費(fèi)用的減少或避免、差錯(cuò)的減 少、靈活性的增加、動(dòng)作速度的提高和管理計(jì)劃方面的改進(jìn)等，包括： 一次性收益 ] [說明能夠用人民幣數(shù)目表示的一次性收益，可按數(shù)據(jù)處理、用戶、管理和支持等項(xiàng)分類敘述。 ] 非一次性收益 [說明在整個(gè)系統(tǒng)生命期內(nèi)由于運(yùn)行所建議系統(tǒng)而導(dǎo)致的按月的、按年的能用人民幣數(shù)目表示的收益，包括開支的減少和避免。 ] 不可定量的收益 [逐項(xiàng)列出無法直用人民幣表示的收益。 ] 收益 /投資比 [求出整個(gè)系統(tǒng)生命期的收益 /投資比值。 ] 投資回收周期 [求出收益的累計(jì)數(shù)開始超過支出的累計(jì)數(shù)的時(shí)間。 ] 敏感性分析 [是指一些關(guān)鍵性因素與這些不同類型之間的合理搭配、處理速度要求、設(shè)備和軟件的配置等變化時(shí)，對開支和收益的影響最靈敏的范圍的估計(jì)。 ] 7. 社會(huì)因素方面的可能性 .[法律方面的可行性 ] .[使用方面的可行性 ] 8. 結(jié)論 [在進(jìn)行可行性研究報(bào)告的編制時(shí)，必須有一個(gè)研究的結(jié)論 ] 軟件項(xiàng)目商業(yè)性分 析 編者 說明： 隨著市場經(jīng)濟(jì)的不斷發(fā)展，一個(gè)項(xiàng)目的商 業(yè)價(jià)值、市場價(jià)值往往是衡量項(xiàng) 目價(jià)值的最大依據(jù)。該文檔模板十分適用于產(chǎn)品型項(xiàng)目，當(dāng)你提出一個(gè)新的產(chǎn)品開發(fā)方向時(shí)，一份商業(yè)性分 析是說服管理層的一個(gè)很好工具。 當(dāng)然，如果是一些內(nèi)部項(xiàng)目，也是可以借鑒該文檔模板來論證該項(xiàng)目的商業(yè)價(jià)值。 1. 文檔概述 [該部分主要描述該文檔的目的、范圍、術(shù)語以及參考資料等方面的內(nèi)容。 ] 目的 [說明該文檔的作用。 ] 范圍 [簡要說明該與文檔相關(guān)的其它事物與資料。 ] 術(shù)語 [列出所有將出現(xiàn)于本文檔的新術(shù)語、縮略語等。 ] 參考資料 [在此應(yīng)列出項(xiàng)目計(jì)劃中引用的文檔列表 ，對于引用的每個(gè)文檔都應(yīng)該列出其標(biāo)題、文檔編號(hào)、日期，并且指出這些文檔的來源，以方便該計(jì)劃的閱讀者查找。 ] 概述 [本小節(jié)說明該文檔所包括的內(nèi)容，以及它的組織方式。 ] [在此簡要地說明將要開發(fā)的系統(tǒng)，包括其名稱、系統(tǒng)所解決的問題以及它的開發(fā)價(jià)值等，從而使得讀者能夠有一個(gè)直接的了解。并且在這處還應(yīng)列出與在本文檔中出現(xiàn)的縮略詞的解釋，以便讀者更好地閱讀。 ] [這一小節(jié)主要說明要開發(fā)的系統(tǒng)所處于的業(yè)務(wù)環(huán)境。它包括系統(tǒng)所面向的領(lǐng)域、用戶。也可以在此指出它是產(chǎn)品型項(xiàng)目，還 是用戶定制型項(xiàng)目，同時(shí)如果該項(xiàng)目與原有的項(xiàng)目有緊密的聯(lián)系，在此也應(yīng)該把這些聯(lián)系列出來。 ] [這一小節(jié)則用于深入說明為什么要開發(fā)該系統(tǒng)，它有什么價(jià)值。最好還應(yīng)對進(jìn)度計(jì)劃、進(jìn)度風(fēng)險(xiǎn)做一些評估。一個(gè)明確確定、表述清晰、可以度量的目標(biāo)將為今后系統(tǒng)的開發(fā)工作 打下堅(jiān)實(shí)的基礎(chǔ)。 ] 5. 財(cái)務(wù)預(yù)測 [如果是產(chǎn)品型項(xiàng)目，那么其輸出就是一個(gè)商業(yè)軟件產(chǎn)品。對于這樣的項(xiàng)目，在此應(yīng)該包括對該項(xiàng)目的財(cái)務(wù)預(yù)測，最主要應(yīng)該得出投資回報(bào)（ ROI）指標(biāo)。在做 ROI 分析時(shí)，應(yīng)該針對不同的完成時(shí)間做出不同的預(yù)測，以讓系統(tǒng)開發(fā)者對于 進(jìn)度延遲對投資回報(bào)的損傷有一個(gè)直觀的了解。 ] [在財(cái)務(wù)預(yù)測中，有一個(gè)基點(diǎn)就是對項(xiàng)目工作量、資源使用的估算，在這里還應(yīng)給出估算的基礎(chǔ)技術(shù)，當(dāng)然這里的估算會(huì)隨著項(xiàng)目的進(jìn)展而逐步精化，應(yīng)該這里還是應(yīng)該估算出一個(gè)合理的范圍。 ] 6. 約束 [任何事有利就有弊，在本小節(jié)則主要列舉執(zhí)行該項(xiàng)目時(shí)會(huì)遇到的一個(gè)諸如外部接口、標(biāo)準(zhǔn)、認(rèn)證、特殊的技術(shù)等約束，這些約速將會(huì)對項(xiàng)目帶來很大的執(zhí)行風(fēng)險(xiǎn)，可能對項(xiàng)目的成本也帶來巨大的影響。 ] 軟件開發(fā)項(xiàng)目立項(xiàng)表 編者說明 ： 在許多開發(fā)組織中，開發(fā)立項(xiàng)請求通常來自市場部門，該表格的設(shè)計(jì) 就是為了更好地理順兩個(gè)部門之間的溝通與協(xié)調(diào)，也使得開發(fā)立項(xiàng)流程化，你可以根據(jù)自己公司的實(shí)際情況，對該表格的格式做一些修改。 項(xiàng)目名稱 (暫定 )： 項(xiàng)目編號(hào)（開發(fā)部填寫） 項(xiàng)目申請人： 申請日期： 項(xiàng)目優(yōu)先級(jí)： 最遲完成時(shí)間： 問題 /機(jī)會(huì)： 項(xiàng)目目標(biāo)及成功標(biāo)準(zhǔn)： 目標(biāo)描述： 假設(shè)、風(fēng)險(xiǎn)及障礙： 客戶名單： 項(xiàng)目提出人： 項(xiàng)目決策人： 項(xiàng)目相關(guān)人員： 審批人意見： 簽名： 日期： 軟件項(xiàng)目計(jì)劃 (ISO 標(biāo)準(zhǔn) ) 編者說明： 拿破侖說過：“沒有一場戰(zhàn) 役 是按照計(jì)劃打的，而 勝利的戰(zhàn)役沒有一個(gè)是沒有計(jì)劃的?！保? 戰(zhàn)役尚且如此，軟件項(xiàng)目也不例個(gè)。一個(gè)經(jīng)過周密考慮，團(tuán)隊(duì)協(xié)作共同制訂的項(xiàng)目計(jì)劃是成功的 關(guān)鍵。本文檔模板是 ISO 標(biāo)準(zhǔn)模板，雖然時(shí)間有點(diǎn)久遠(yuǎn)，但還是十分有參考價(jià)值的。 1. 引言 編寫目的 [說明編寫這份項(xiàng)目開發(fā)計(jì)劃的目的，并指出預(yù)期的讀者。 ] 背景 a. 待開發(fā)軟件系統(tǒng)的名稱； b. 本項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶及實(shí)現(xiàn)該軟件的計(jì)算中心或計(jì)算機(jī)網(wǎng)絡(luò)； c. 該軟件系統(tǒng)同其他 系統(tǒng)或其他機(jī)構(gòu)的基本的相互來往關(guān)系。 定義 [列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。 ] 參考資料 [列出用得著的參考資料。 ] 2. 項(xiàng)目概述 工作內(nèi)容 [簡要地說明在本項(xiàng)目的開發(fā)中須進(jìn)行的各項(xiàng)主要工作。 ] 主要參加人員 [扼要地說明參加本項(xiàng)目開發(fā)工作的主要人員的情況，包括他們的技術(shù)水平。 ] 產(chǎn)品 程序 [列出需移交給用戶的程序的名稱、所用的編程語言及存儲(chǔ) 程序的媒體形式，并通過引用有關(guān)文件。逐項(xiàng)說明其功能和能力。 ] [列出需移交給用戶的每種文件的名稱及內(nèi)容要點(diǎn)。 ] [列出需向用戶提供的各項(xiàng)服務(wù)。 ] [說明開發(fā)集體應(yīng)向本單位交出但不必向用戶移交的產(chǎn)品。 ] 驗(yàn)收標(biāo)準(zhǔn) [對于上述這些應(yīng)交出的產(chǎn)品和服務(wù)，逐項(xiàng)說明或引用資料說明驗(yàn)收標(biāo)準(zhǔn)。 ] [完成項(xiàng)目的最遲期限 ] [本計(jì)劃的批準(zhǔn)者和批準(zhǔn)日期 ] 3. 實(shí)施計(jì)劃 工作任務(wù)的分 解與人員分工 [對于項(xiàng)目開發(fā)中需完成的各項(xiàng)工作，從需求分析、設(shè)計(jì)、實(shí)現(xiàn)、測試直到維護(hù)，包括文件的編制、審批、打印、分發(fā)工作，用戶培訓(xùn)工作，軟件安裝工作等，按層次進(jìn)行分解，指明每項(xiàng)任務(wù)的負(fù)責(zé)人和參加人員。 ] 接口人員 [說明負(fù)責(zé)接口工作的人員及他們的職責(zé)。 ] 進(jìn)度 [對于需求分析、設(shè)計(jì)、編碼實(shí)現(xiàn)、測試、移交、培訓(xùn)和安裝等工作，給出每項(xiàng)工作任務(wù)的預(yù)定的開始日期、完成日期及所需資源，規(guī)定各項(xiàng)工作任務(wù)完成的先后順序以及表征每項(xiàng)工作任務(wù)完成的標(biāo)志性事件。 ] 預(yù)算 [逐項(xiàng)列出本開發(fā)項(xiàng)目所需要的勞務(wù)以及經(jīng)費(fèi)的預(yù)算和來源。