【導(dǎo)讀】在程序員的日常工作中，除了編寫代碼之外，還免不了需要編寫各種技術(shù)文檔。編寫良好的技術(shù)文檔在項目中能夠很好地建立溝通與協(xié)作，起到很積極的作用。技術(shù)文檔也就成為了程序員技能提升的很重要的一面。式和簡單的寫作說明，相信能夠幫助大家編寫出更加高效、實用的技術(shù)文檔。我們十分注重其實用性，以確保每個模板的價值，而且對于一些重要的文檔提供了多個模板。中所將使用到的文檔模板，共計14個；5）其它類：除此之外，還收集了關(guān)于用戶手冊、軟件維護(hù)等方面的10個文檔模板，其中還有一個軟件過程規(guī)范的示例。[編寫本可行性研究報告的目的，指出預(yù)期的讀者。[說明對這項開發(fā)中給出的條件、假定和所受到期的限制。示，并加以敘述。[列出現(xiàn)有系統(tǒng)所承擔(dān)的工作及工作量。運行期間所需的費用。人民幣數(shù)目表示的收益，包括開支的減少和避免。[逐項列出無法直用人民幣表示的收益。[簡要說明該與文檔相關(guān)的其它事物與資料。

　　

【正文】 業(yè)務(wù)目標(biāo) [用一個定量和可測量的合理方法總結(jié)產(chǎn)品總結(jié)產(chǎn)品所帶來的重要商業(yè)利潤。關(guān)于給客戶帶來的價值在后面闡述，這里僅把重點放在給業(yè)務(wù)的價值上 。這些目標(biāo)與收入預(yù)算或節(jié)省開支有關(guān)，并影響到投資分析和最終產(chǎn)品的交付日期。 ] 客戶或市場需求 [描述一些典型客戶的需求，包括不滿足現(xiàn)在市場上的產(chǎn)品或信息系統(tǒng)的需求。提出客戶目前所遇到的問題在新產(chǎn)品中將可能（或不可能）出現(xiàn)的闡述，提供客戶怎樣使用產(chǎn)品的例子。確定了產(chǎn)品所能運行的軟、硬件平臺。定義了較高層次的關(guān)鍵接口或性能要求，但避免設(shè)計或?qū)崿F(xiàn)細(xì)節(jié)。把這些要求寫到列表中，可以反過來跟蹤調(diào)查特殊用戶和功能需求。 ] 提供給客戶的價值 [確定產(chǎn)品給客戶帶來的價值，并指明產(chǎn)品怎樣滿足客戶的需要?？梢杂孟?列言辭表達(dá)產(chǎn)品帶給客戶的價值： ? 提高生產(chǎn)效率，減少返工； ? 節(jié)省開支； ? 業(yè)務(wù)過程的流水線化； ? 先前人工勞動的自動化； ? 符合相關(guān)標(biāo)準(zhǔn)和規(guī)則； ? 與目前的應(yīng)用產(chǎn)品相比較，提高了可用性或減少了失效程度。 ] 業(yè)務(wù)風(fēng)險 [總結(jié)開發(fā)（或不開發(fā)）該產(chǎn)品有關(guān)的主要業(yè)務(wù)風(fēng)險，例如市場競爭、時間問題、用戶的接受能力、實現(xiàn)的問題或?qū)I(yè)務(wù)可能帶來的消極影響。預(yù)測風(fēng)險的嚴(yán)重性，指明你 所能采取的減輕風(fēng)險的措施。 ] [文檔中的這一部分為系統(tǒng)建立了一個長遠(yuǎn)的項目視圖，它將指明業(yè)務(wù)目標(biāo)。這一項目視圖為在軟件開發(fā)生 存期中作出決策提供了相關(guān)環(huán)境背景。這部分不包括詳細(xì)的功能需求和項目計劃信息。 ] 項目視圖陳述 [編寫一個總結(jié)長遠(yuǎn)目標(biāo)和有關(guān)開發(fā)新產(chǎn)品目的的簡要項目視圖陳述。項目視圖陳述將考慮權(quán)衡有不同需求客戶的看法。它可能有點理想化，但必須以現(xiàn)有的或所期待的客戶市場企業(yè)框架。組織的戰(zhàn)略方向和資源局限性為基礎(chǔ)。 ] [如： 化學(xué)制品跟蹤系統(tǒng) 可使科學(xué)家查詢到化學(xué)制品倉庫或供應(yīng)商將提供的化學(xué)制品容器。系統(tǒng)可隨時了解公司每一個化學(xué)制品容器所處的位置，容器中所剩余的藥品劑量，任何時候每個容器所處的位置和用法的歷史記錄。通過充 分利用公司內(nèi)部的可用化學(xué)制品，廢棄極少量已使用或過期失效的化學(xué)制品，使用標(biāo)準(zhǔn)的化學(xué)制品的購買過程等將在化學(xué)制品上節(jié)省 25%開支。 化學(xué)制品跟蹤系統(tǒng) 還能產(chǎn)生符合政府部門規(guī)定所要求的全部報表，包括化學(xué)制品的使用、存儲和廢棄等報表。 ] 主要特征 [包括新產(chǎn)品將提供的主要特性和用戶性能的列表。強調(diào)的是區(qū)別于以往產(chǎn)品和競爭產(chǎn)品的特性?？梢詮挠脩粜枨蠛凸δ苄枨笾械玫竭@些特性。 ] 假設(shè)和依賴環(huán)境 [在構(gòu)思項目和編寫項目視圖和范圍文檔時，要記錄所作出的任何假設(shè)。通常一方所持的假設(shè)應(yīng)與另一方不同。如果你把它 們都記錄下來，并加以評論，就能對項目內(nèi)部隱含的基本假設(shè)達(dá)成共識。比如， 化學(xué)制品跟蹤系統(tǒng) 的開發(fā)者假設(shè)：該系統(tǒng)可以替代現(xiàn)有的倉庫存貨系統(tǒng)，并能與有關(guān)采購部門的應(yīng)用相連接。把這些都記錄下來以防止將來可能的混淆和沖突。還有，記錄項目所依賴的主要環(huán)境，比如：所使用的特殊的技術(shù)、第三方供應(yīng)商、開發(fā)伙伴及其它業(yè)務(wù)關(guān)系。 ] [項目范圍定義了所提出的解決方案和概念和適用領(lǐng)域，而局限性則指出產(chǎn)品所不包括的某些性能。如果一般客戶所提出的需求超出項目的范圍時就應(yīng)當(dāng)拒絕它，除非這些需求是很有益的。記錄這些需求以 及拒絕它們的原因，以待查。 ] 首次發(fā)行的范圍 [總結(jié)首次發(fā)行的產(chǎn)品所具有的性能。描述了產(chǎn)品的質(zhì)量特性，這些特性使產(chǎn)品可以為不同的客戶群提供預(yù)期的成果。應(yīng)當(dāng)避免將想到的每一個特性都包括到 版本產(chǎn)品中去。開發(fā)者應(yīng)把重點放在能提供最大價值、花花費最合理的開發(fā)費用及普及率最高的產(chǎn)品上。 ] 隨后發(fā)行的范圍 [如果你想象一個周期性的產(chǎn)品演變過程，就要指明哪一個主要特性的開發(fā)將被延期，并期待隨后版本發(fā)行的日期。 ] 局限性和專用性 [明確定義包括和不包括的特性和功能的界線是處理范圍設(shè)定和客戶期望 的一個途徑。列出風(fēng)險承擔(dān)者們期望的而你卻不打算把它包括到產(chǎn)品中的特性和功能。 ] [這一部分總結(jié)了一些項目的業(yè)務(wù)問題。 ] 客戶概貌 [客戶概述明確了這一產(chǎn)品的不同類型客戶的一些本質(zhì)特點，以及目標(biāo)市場部門和在 這些部門中的不同客戶的特征。對于每一種客戶類型，概述要包括： ? 各種客戶類型將從產(chǎn)品中獲得的主要益處； ? 它們對產(chǎn)品所持的態(tài)度； ? 感興趣的關(guān)鍵產(chǎn)品的特性； ? 哪一類型客戶能成功使用； ? 必須適應(yīng)任何客戶的限制。 ] 項目的優(yōu)先級 [一旦明確建立項目的優(yōu)先級，風(fēng)險承擔(dān)者和項目的參與者就能把 精力集中在一系列共同的目標(biāo)上。達(dá)到這一目的的一個途徑是考慮軟件項目的五個方面：性能、質(zhì)量、計劃、成本和人員。在所給的項目中，其每一方面應(yīng)與下面三個因素之一相適應(yīng)。 ? 一個驅(qū)動 一個最高級別的目標(biāo)； ? 一個約束 項目管理者必須操縱一個對象的限制因素； ? 一個自由度 項目管理能權(quán)衡其它方面，進(jìn)而在約束限制的范圍內(nèi)完成 目標(biāo)的一個因素。 未必所有的因素都能成為驅(qū)動，或所有的因素都能成為約束因素。在項目開始時記錄和分析哪一個因素適用于哪一類型，將有助于使每一個人的努力和期望與普遍認(rèn)可的優(yōu)先級相一致。 ] [明確產(chǎn)品的成功是如何定義和測量的，并指明對產(chǎn)品的成功有巨大影響的幾個因素。不僅要包括組織直接控制的范圍內(nèi)的事務(wù)，還要包括我部素。如果可能，可建立測量的標(biāo)準(zhǔn)，用于評價是否達(dá)到業(yè)務(wù)目標(biāo)，如：市場股票、銷售量及收入、客戶滿意度、交易處理量和準(zhǔn)確度。 ] 項目構(gòu)想 編者說明： 這個 文檔模板與“軟件項目視圖與范圍”文檔的功能十分接近，只不過該文檔更適合于產(chǎn)品型項目。其注重對項目的用戶、市場進(jìn)行分析，緊抓項 目相關(guān)人員（也叫做風(fēng)險承擔(dān)者）的需求的本質(zhì)。 [軟件需求規(guī)格說明書的整個內(nèi)容還是鎖定于整個系統(tǒng)的操作、使用層面之上的功能性需求，只是解決了 How的問題，而并未回答 Why的問題。這使得系統(tǒng)在開發(fā)過程中，開發(fā)團(tuán)隊經(jīng)常陷入知其然，而不知其所以然的困境，造成了不必要的誤解與錯誤。因此，需要一個側(cè)重于對項目的風(fēng)險承擔(dān)者、目標(biāo)用戶需要的文檔，不僅要了解他們需要的功能，還要找到他們提出這些需求的原因。這就是“項目構(gòu)想”文檔所要描述的重要內(nèi)容。 ] [本節(jié)的內(nèi)容主要是提供項目構(gòu)想文檔的目的、范圍、定義、參考資料以及對其的摘要性概述。 ] 目的 [說明該文檔的寫作目的 。 ] 范圍 [范圍主要用來說明該文檔描述的項目內(nèi)容，以及與其相關(guān)的其它東西。 ] 定義、首字母縮寫詞和縮略語 [與其它文檔一樣，該文檔也需要將本文檔中所涉及的所有術(shù)語、縮略語進(jìn)行詳細(xì)的定義。還有一種可簡明的做法，就是維護(hù)在一個項目詞匯表中，這樣就可以避免在每個 文檔中都重復(fù)很多內(nèi)容。 ] 參考資料 [在這一小節(jié)中，應(yīng)完整地列出該文檔引用的所有文檔。對于每個引用的文檔都應(yīng)該給出標(biāo)題、標(biāo)識號、日期以及來源，為閱讀者查找這些文檔提供足夠詳細(xì)的信息。 ] 概述 [在本小節(jié)中，主要是說明項目構(gòu)想 各個部分所包含的主要內(nèi)容，就像一個文章摘要一樣。同時也應(yīng)該對文檔的組織方式進(jìn)行解釋。 ] 商業(yè)機會 [如果該項目是一個產(chǎn)品型項目，那么應(yīng)該在本小節(jié)中描述該產(chǎn)品所針對的商業(yè)機會。如果是定制開發(fā)項目，那么可以省去本小節(jié)。 ] 問題說明 [使用表格的形式，將該項目將要解決的問題進(jìn)行概要性地描述： ] 存在的問題 [問題的簡要說明 ] 受影響的人群 [該問題對哪些人群帶來了影響 ] 導(dǎo)致的后果 [該問題帶來的不利因素 ] 希望的解決方案 [列出解決方案所能夠解決的問題，以及其相應(yīng)的優(yōu)點。 ] 產(chǎn)品定位說明 [如果是產(chǎn)品型項目，則該小節(jié)將以表格的形式對產(chǎn)品的定位進(jìn)行明確，如果是定制開發(fā)項目，可以省略本小節(jié)。 ] 目標(biāo)市場 [描述產(chǎn)品目標(biāo)客戶群體 ] 目標(biāo)客戶需求 [說明客戶的需要或者潛在的機會 ] 產(chǎn)品類別 [說明該產(chǎn)品屬于什么領(lǐng)域 ] 主要優(yōu)點 [描述讓目標(biāo)客戶產(chǎn)生興趣和購買欲的理由 ] 主要競爭對手 [列出與該產(chǎn)品有競爭的其它廠商的產(chǎn)品 ] 主要優(yōu)勢 [針對競爭產(chǎn)品的分析 ] [一個具有清晰定位的產(chǎn)品，在開發(fā)過程中，團(tuán)隊將更好地理解，更容易開發(fā)出滿足目標(biāo)市場的產(chǎn)品，因而該部分內(nèi)容是十分重要 的。 ] [了解用戶、了解所有與該項目相關(guān)的人員，是有效地滿足他們對系統(tǒng)、產(chǎn)品需求的基礎(chǔ)。你應(yīng)該在本小節(jié)中將所有的項目相關(guān)人員以及用戶收羅在一起，并對他們進(jìn)行簡要的描述，對他們的需求、習(xí)慣、角度進(jìn)行說明。這些內(nèi)容將有助于開發(fā)團(tuán)隊更好的理解用戶的需求本質(zhì)。 ] 產(chǎn)品用戶分析 [如果是產(chǎn)品型項目，那么你應(yīng)該本節(jié)中對目標(biāo)客戶進(jìn)行分析?？梢栽谑袌稣{(diào)查的基礎(chǔ)上，對其市場的規(guī)模和增長率進(jìn)行研究，從而估計其潛在的用戶數(shù)量。另外，還應(yīng)結(jié)合目標(biāo)市場的實際情況，分析你的組織是否在該市場上有拓展的 優(yōu)勢，如何獲得這些優(yōu)勢。如果是定制開發(fā)項目，可以省略這一小節(jié)。 ] 項目相關(guān)人員一覽表 [使用下面的表格，對項目相關(guān)人員進(jìn)行分析。 ] 人員類別 代表 作用 [指明項目相關(guān)人員的類別 ] [列舉該類人員的代表 ] [說明其對產(chǎn)品、項目開發(fā)的影響 ] 用戶一覽表 [使用下面的表格，對項目、產(chǎn)品的用戶進(jìn)行分析。 ] 用戶類型 說明 代表 [指明用戶類別 ] [簡要說明他們在系統(tǒng)中代表的對象和充當(dāng)?shù)淖饔?] [列舉出代表 ] 用戶環(huán)境 [了解用戶在使用環(huán)境下使用系統(tǒng)或產(chǎn)品，是十分有意義的事，也是實 現(xiàn)產(chǎn)品更好地滿足需求，提供更加方便的使用界面的基礎(chǔ)。例如： 該任務(wù)由多少人來完成？是否總在變化？一個任務(wù)周期需要多長時間？執(zhí)行每項活動要用多長時間？是否總在變化？是否有特殊的環(huán)境約束：移動、戶外、乘機旅行等？目前使用的是哪些系統(tǒng)平臺？以后會使用哪些平臺？還在使用哪些應(yīng)用程序？您的應(yīng)用程序是否需要和這些應(yīng)用程序集成？他們的計算機硬件系統(tǒng)的環(huán)境情況如何？他們都是在什么樣的工作環(huán)境中使用系統(tǒng)的？ ] 項目相關(guān)人員的簡要說明 [以下表的形式，將各類項目相關(guān)人員的基本情況進(jìn)行說明，以幫助開發(fā)團(tuán)隊更好地了解他們的 情況。為每一類人員生成一張表格。 ] 代表 [列出該類項目相關(guān)人員的代表。 ] 說明 [對該類人員進(jìn)行簡要說明。 ] 專業(yè)技能 [描述本類人員的技能特長、技術(shù)背景以及電腦系統(tǒng)操作的熟練程度（可以分成業(yè)務(wù)用戶、專家用戶、熟練用戶、初級用戶等） ] 職責(zé) [描述本類人員對系統(tǒng)開發(fā)所承擔(dān)的職責(zé)，以及應(yīng)享有的利益。 ] 驗收標(biāo)準(zhǔn) [描述驗證系統(tǒng)是否滿足其職責(zé)的標(biāo)準(zhǔn)。 ] 參與方式 [該類人員是否參與系統(tǒng)開發(fā)，如果參與將以什么形式參加。 ] 項目成果 [說明該類項目相關(guān)人員是否參與項目成果的開發(fā)，是否有與其相關(guān)的項目成 果。 ] 意見 /問題 [列出與該類項目成員相關(guān)的問題與建議。 ] 用戶簡要說明 [以下表的形式，將與系統(tǒng)相關(guān)的各種用戶的信息整理出來，以方便開發(fā)團(tuán)隊針對性的工作。要注意的是，用戶會有不同的類型，有些用戶需要的是靈活性、方便快速操作的高級功能，而有些用戶則側(cè)重與用戶界面的友好性。這些與該用戶的基本情況直接相關(guān)，了解用戶才能夠真正地開發(fā)出符合用戶習(xí)慣和水平的系統(tǒng)。為每類用戶生成一張表。 ] 代表 [列出該類用戶的代表。 ] 說明 [對該類用戶進(jìn)行簡要說明。 ] 專業(yè)技能 [描述該用戶的技能特長、技術(shù)背景和 對計算機系統(tǒng)操作的熟練程度。 ] 職責(zé) [列出該用戶對所開發(fā)的系統(tǒng)負(fù)有的關(guān)鍵職責(zé)，如記錄詳細(xì)信息、撰寫報告、協(xié)調(diào)工作等。 ] 驗收標(biāo)準(zhǔn) [描述驗證系統(tǒng)符合用戶需求的標(biāo)準(zhǔn)。 ] 參與方式 [說明該類用戶是否參與開發(fā)，如何參與。 ] 項目成果 [說明是否有依賴于該類用戶的項目成果。 ] 意見 /問題 [列出一些該類用戶對系統(tǒng)提出的一個意見與建議，并 且收集其認(rèn)為該系統(tǒng)將遇到的問題。 ] 關(guān)鍵的項目相關(guān)人員 /用戶需要 [列出項目相關(guān)人員提出的針對對于該解決方案的關(guān)鍵問題。對于列出的每個問題，需澄清：為什么會出 現(xiàn)這一問題？目前的解決方案是什么？他們需要什么要的解決方案？或者對新的解決方案有什么樣的預(yù)期？ ] [還有一個很關(guān)鍵的內(nèi)容就是，每個需求的優(yōu)先級，這將對制定迭代計劃時提供有效的基礎(chǔ)，而優(yōu)先級的確定，應(yīng)該采用分級、累積投票等方法從用戶、項目相關(guān)人員那里獲得。應(yīng)充分考慮項目客戶方的要求。如果是產(chǎn)品型項目，則應(yīng)該從產(chǎn)品經(jīng)理、市場調(diào)查資料里獲得。 ] [經(jīng)過整理后，將內(nèi)容填入下表： ] 需求 優(yōu)先級 要點 目前解決方案 提議的解決方案 備選方案和競爭 [如果是產(chǎn)品型項目，應(yīng)在此小節(jié)列舉出客戶除了購買 該產(chǎn)品這外的選擇，其中包括購買競爭對手的產(chǎn)品、自行設(shè)計解決方案甚至是維持現(xiàn)狀。對所有潛在的競爭產(chǎn)品做一個列表，并根據(jù)客戶的實際情況來確認(rèn)主要優(yōu)缺點。 ] [而如果是定制開發(fā)型項目，則應(yīng)該了解競爭對手提供的解決方案，比在此進(jìn)行相應(yīng)的比較。 ] 4. 產(chǎn)品概述 [本節(jié)主要從產(chǎn)品級、系統(tǒng)級的視角，高度概括產(chǎn)品的功能、與其它應(yīng)用程序的交互以及所需的系統(tǒng)配置等。 ] 產(chǎn)品總體效果 [本小節(jié)主要將產(chǎn)品話在用戶環(huán)境、使用環(huán)境的角