1項目文檔的螢要性

　　文檔是軟件項目開發(fā)應(yīng)用的一部分，存在于軟件項目的整個生命周期之巾，沒有正式文檔的軟件項目開發(fā)，就不是標(biāo)準(zhǔn)規(guī)范的軟件項目。文檔Bug是軟件缺陷的一種表現(xiàn)形式，通?？蛻舨⒉恢牢臋n是否存在Bug，如果按照帶有缺陷的文檔進(jìn)行安裝操作，同樣會造成不良的后果，甚至帶來損失，在實(shí)際工作中因文檔質(zhì)量不高，造成軟件投產(chǎn)后出現(xiàn)系統(tǒng)宕機(jī)、延誤生產(chǎn)的問題時有發(fā)生。因此，文檔的編制和管理在軟件項目開發(fā)中占有突出的地位和相當(dāng)大的工作量，高質(zhì)量、高效率地設(shè)計、編制、分發(fā)、管理和維護(hù)文檔，對于轉(zhuǎn)讓、變更、修正、擴(kuò)充和使用文檔，對于提高軟件項目的質(zhì)量和客戶滿意度有著重要的現(xiàn)實(shí)意義。

　　2文檔管理的方式

　　在項目實(shí)施過程中，由于項目實(shí)施的復(fù)雜性，多方人員參加以及時間跨度長等因素，所以有關(guān)需求、建議、解決方案和會議、問題記錄等都必須文檔化、標(biāo)準(zhǔn)化，以便查閱和引用。這些文檔伴隨著項目實(shí)施的各個階段逐漸充實(shí)、完善；與此同時，它們亦記載跟蹤了整個實(shí)施的過程和成果。因此，在文檔管理的過程中，需要把握住一些重要的原則和方法，這樣可以讓我們的文檔真正達(dá)到預(yù)期的目的。

　　2．1文檔模板的管理

　　面對項目中需要建立的各類紛繁復(fù)雜的文檔，如果各式各樣，每個人一個風(fēng)格，不論從美觀性和可讀性上都會有影響，所以在文檔管理中的過程中應(yīng)建立一套文檔的模板。

　　在建立文檔模板時，需要對一些格式進(jìn)行要求，需要將一些基本的要素固化到文檔模板中，確保文檔需要的內(nèi)容能夠在文檔中體現(xiàn)，例如文檔的頁眉頁腳、文檔變更歷史、文檔的目錄方式、文檔的字體等。

　　在建立文檔時，要注意做好文檔的分類，各種分類有一個清晰的定義，使用者可以清楚地知道實(shí)際使用時要采用哪種模板。如果是使用共享目錄方式管理文檔，需要在一個相對容易找到的文件夾目錄中存放模板，如果是使用信息系統(tǒng)方式進(jìn)行模板管理，最好能夠在首頁進(jìn)行一個鏈接，讓使用者可以快速的搜索到。在建立分類時，需要含有一個共同類，或者叫做公用類，因?yàn)樵趯?shí)際的使用過程中總是會有一些新的類別出現(xiàn)，也會有一些無法進(jìn)行分類的文檔，這個時候就可以通過共同類進(jìn)行管理。
對于文檔模板的變更需要能夠做到及時告知使用者，并做好版本管理。

　　2_2文檔目錄的管理

　　為了能夠在紛繁復(fù)雜的文檔中找到需要的文檔，需要在進(jìn)行文檔管理時建立一套完整的文檔目錄體系，主要包括文檔的索引管理和文檔的分類管理。

　　在進(jìn)行文檔管理前，需要對不同的文檔建立一個分類，建議不同的分類可以便于文檔的查找，也可以針對不同的分類制定不同的管理要求。如果是文件夾方式管理，還需要分別不同的文件夾內(nèi)容的安排以及權(quán)限的控制，因?yàn)槲募A管理的特殊性，需要注意其權(quán)限管理的簡潔化；如果是采用信息系統(tǒng)管理，需要注意類型的編碼體系的建立。一個好的文檔分類體系可以讓使用者方便地進(jìn)行文檔的歸類和查找，文檔的分類在一些管理過程中還需要注意歸檔管理的需求。

　　對于文檔，需要建立一套索引機(jī)制，這里之所以特別提出索引機(jī)制，是因?yàn)樵谌粘５奈臋n使用中，會發(fā)現(xiàn)一些很多類似的文檔，或者類似的內(nèi)容說明，由于不同的撰寫者會對一些基本的概念或者原則的說明會存在一些差異，這個時候就需要能夠有一個索引來明確什么是最準(zhǔn)確的，這一點(diǎn)在項目管理過程中特別重要，因?yàn)橐粋€項目組往往會不時的發(fā)生一些變動，后來人面對多個說法時很難知道什么足對的，同時一些實(shí)際情況也會發(fā)生變動，一些說法也需要進(jìn)行修正，而之前的一些文檔也無法進(jìn)行更正，所以這個時候也需要有一個索引來明確正確的說法，這一點(diǎn)問題也可以通過文檔版本的管理加以改善。

　　2_3文檔的命名規(guī)范

　　各種文檔，如果名稱多樣，或者名稱含義模糊將會造成使用和交流上的不便．需要建立一套有效的命名規(guī)范體系。

　　對于文檔的名稱，首先需要名稱能夠容易識別，有些使用者不是很注意文檔的名稱，經(jīng)常直接用文件的默認(rèn)名稱，或者就是一個自己的姓名、項目的名稱等，其他的使用者很難識別是什么類型的文檔。

　　在文檔的使用過程中，可以規(guī)定在文檔的某些部位必須放置文檔的類型或者某些其他關(guān)鍵寧，例如將求將文檔的類別放在文件名的頭部，對于月度性的文檔，規(guī)定頭部必須放某年某月，等等。

　　對于一些分不同版本的文檔，可以要求分不同的版本進(jìn)行管理，文件名稱中注明版本號，劉于終稿等一些標(biāo)志性的內(nèi)容可以加一些特殊的標(biāo)識，這樣可以明確其重要性和權(quán)威性。

　　這些方式將有助于文檔的文件名的整潔和清晰，使用者在找時也較為方便。在進(jìn)行文檔的交互調(diào)整過程中，也可以增加一些13期或者修改者的標(biāo)識來進(jìn)行傳遞，主要的同的在于能夠唯一識別一個文檔，減少互相溝通的障礙。
2-4文檔的變更管理

　　文檔在使用過程中發(fā)生變更是很常見的現(xiàn)象，對于發(fā)生變更的文檔，需要通過手段加以約束，最常用的方法就是版本的管理，對于形成的文檔及時進(jìn)行歸檔保存。

　　文檔發(fā)生變更時，需要能夠做到兩點(diǎn)：第一，文檔有清晰的變更記錄，主要是針對變化的部分。不能讓每個使用者在文檔發(fā)生變化后都需要把文件通篇讀一遍；第二，文檔的最終版本要能方便的閱覽，如果出現(xiàn)只能看變更歷史才知道最終版本的話將大大提高使用成本在文檔發(fā)生變更時，需要能夠通過必要的途徑通知相關(guān)人，例如通過郵件通知或者公告通知的方式，避免新的文檔產(chǎn)生后還有大量的使用者使用舊的文檔，在實(shí)際操作環(huán)境中IS09000管理使用的簽字回收重要文檔的方式很值得借鑒，當(dāng)然對一些電子文檔需要采用一些其他變通的方式來處理。

　　2．5文檔的審核制度

　　很多文檔作為一種指導(dǎo)性文件，需要有一定的嚴(yán)肅性和權(quán)威性，因而對文檔進(jìn)行必要的審核是必須的。

　　文檔的審核時機(jī)一般為文檔建立時和文檔發(fā)生變更時，對于文檔的適用范圍的變更也應(yīng)該進(jìn)行必要的審核。通過文檔的審核，可以檢查是否存在錯誤的事項或者一些不合理的事項，撰寫者和審核者所處的崗位不同、知識結(jié)構(gòu)不同，對于一個文檔如何撰寫的角度和看法也會不同，在后續(xù)的審核過程中能夠很好的進(jìn)行文檔的校正。同時，文檔的審核機(jī)制也可以明確各自崗位的責(zé)任。

　　總之，信息系統(tǒng)的實(shí)施是一個負(fù)責(zé)的管理過程，需要方方面面的管理工作配合到位。文檔在軟件項目的開發(fā)過程中起到了關(guān)鍵的作用，文檔作為一種日常交流的重要依據(jù)和工作成果的總結(jié)顯得尤為重要，從某種意義上來說，文檔是軟件項目開發(fā)規(guī)范的體現(xiàn)和指南按照規(guī)范要求編制一整套文檔的過程，就是按照開發(fā)規(guī)范完成一個軟件項目開發(fā)的過程。高質(zhì)量的文檔可以提高軟件項目的質(zhì)量，有助于程序員編制程序，有助于管理人員監(jiān)督和管理軟件的開發(fā)，有助于片j戶更好地安裝和使用軟件系統(tǒng)，有助于維護(hù)人員進(jìn)行有效的修改和擴(kuò)充。所以，在軟件項目的開發(fā)過程中，要充分做好軟件文檔的編制和管理工作。作為小型企業(yè)，在文檔管理的過程中既要注意嚴(yán)肅性，又要能兼顧靈活性，要本著在達(dá)到正常的規(guī)范性的基礎(chǔ)上盡可能地方便使用者的使用和交流提高使用效率。

擴(kuò)展閱讀

版權(quán)聲明：