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