為使軟件文檔能起到多種橋梁的作用，使它有助于程序員編制程序，有助于管理人員監(jiān)督和管理軟件的開發(fā)，有助于用戶了解軟件的工作和應做的操作，有助于維護人員進行有效的修改和擴充，文檔的編制必須保證一定的質(zhì)量。下面希賽小編和大家一起來學習一下吧！

    如果不重視文檔編寫工作，或是對文檔編寫工作的安排不當，就不可能得到高質(zhì)量的文檔。質(zhì)量差的文檔不僅使讀者難于理解，給使用者造成許多不便，而且會削弱對軟件的管理(難以確認和評價開發(fā)工作的進展情況)，提高軟件成本(一些工作可能被迫返工)，甚至造成更加有害的后果(如誤操作等)。

    (1)針對性：文檔編制以前應分清讀者對象。按不同的類型、不同層次的讀者，決定怎樣適應他們的需要。例如，管理文檔主要是面向管理人員的，用戶文檔主要是面向用戶的，這兩類文檔不應像開發(fā)文檔(面向開發(fā)人員)那樣過多使用軟件的專用術語。

    (2)精確性：文檔的行文應當十分確切，不能出現(xiàn)多義性的描述。同一課題幾個文檔的內(nèi)容應當是協(xié)調(diào)一致，沒有矛盾的。

    (3)清晰性：文檔編寫應力求簡明，如有可能，配以適當?shù)膱D表，以增強其清晰性。

    (4)完整性：任何一個文檔都應當是完整的、獨立的，它應自成體系。例如，前言部分應做一般性介紹，正文給出中心內(nèi)容，必要時還有附錄，列出參考資料等。

    同一課題的幾個文檔之間可能有些部分內(nèi)容相同，這種重復是必要的。不要在文檔中出現(xiàn)轉(zhuǎn)引其他文檔內(nèi)容的情況。例如，一些段落沒有具體描述，而用“見××文檔x×節(jié)，，的方式，這將給讀者帶來許多的不便。

    (5)靈活性：各個不同軟件項目，其規(guī)模和復雜程度有著許多實際差別，能一律看待。

    1)應根據(jù)具體的軟件開發(fā)項目，決定編制的文檔種類。

    軟件開發(fā)的管理部門應該根據(jù)本單位承擔的應用軟件的專業(yè)領域和本單位的管理能力，制定一個對文檔編制要求的實施規(guī)定。主要是：在不同條件下，應該形成哪些文檔?這些文檔的詳細程度?該開發(fā)單位每一個項目負責人都應當認真執(zhí)行這個實施規(guī)定。

    對于一個具體的應用軟件項目，項目負責人應根據(jù)上述實施規(guī)定，確定一個文檔編制計劃。其中包括：

    應該編制哪幾種文檔，詳細程度如何。

    各個文檔的編制負責人和進度要求。

    審查、批準的負責人和時間進度安排。

    在開發(fā)時期內(nèi)各文檔的維護、修改和管理的負責人，以及批準手續(xù)。

    有關的開發(fā)人員必須嚴格執(zhí)行這個文檔編制計劃。

    2)當所開發(fā)的軟件系統(tǒng)非常大時，一種文檔可以分成幾卷編寫。例如，

    項目開發(fā)計劃可分寫為：質(zhì)量保證計劃、配置管理計劃、用戶培訓計劃、安裝實施計劃等。

    系統(tǒng)設計說明書可分寫為：系統(tǒng)設計說明書、子系統(tǒng)設計說明書。

    程序設計說明書可分寫為：程序設計說明書、接口設計說明書、版本說明。

    -操作手冊可分寫為：操作手冊、安裝實施過程。

    測試計劃可分寫為：測試計劃、測試設計說明、測試規(guī)程、測試用例。

    測試分析報告可分寫為：綜合測試報告、驗收測試報告。

    項目開發(fā)總結報告也可分寫成：項目開發(fā)總結報告、資源環(huán)境統(tǒng)計。

    3)應根據(jù)任務的規(guī)模、復雜性、項目負責人對該軟件的開發(fā)過程及運行環(huán)境所需詳細程度的判斷，確定文檔的詳細程度。

    4)對國標GB8567—88《計算機軟件產(chǎn)品開發(fā)文件編制指南》所建議的所有條款都可以擴展，進一步細分，以適應需要;反之，如果條款中有些細節(jié)并非必需，也可以根據(jù)實際情況壓縮合并。

    5)程序的設計表現(xiàn)形式，可以使用程序流程圖、判定表、程序描述語言(PDI，)、或問題分析圖(PAD)等。

    6)對于文檔的表現(xiàn)形式，沒有規(guī)定或限制。可以使用自然語言、也可以使用形式化的語言。

    7)當國標《計算機軟件產(chǎn)品開發(fā)文件編制指南》中所規(guī)定的文檔種類不能滿足某些應用部門的特殊需要時，可以建立一些特殊的文檔種類要求。這些要求可以包含在本單位的文檔編制實施規(guī)定中。

    《軟件產(chǎn)品開發(fā)文件編制指南》中給出了一個例子，利用求和法綜合衡量12種考慮因素，來確定應編制文檔的種類。使用這個方法的具體過程如下：

    a.針對表所列的12種衡量因素，考察所開發(fā)的軟件。對每一種因素給出一個分值，其范圍從1到5。

    b.把衡量所得的各個因素的值相加，得總和之值。

    c.根據(jù)總和之值，對表表進行查找，確定應編制的文檔的種類。

    其中，數(shù)據(jù)要求說明書欄用**表示應當根據(jù)所開發(fā)軟件的實際需要來確定是否需要編制這個文檔。測試分析報告欄用*表示這個文檔應該編寫，但不必很正規(guī)。

    (6)可追溯性：由于各開發(fā)階段編制的文檔與各個階段完成的工作有密切的關系，前后兩個階段生成的文檔，隨著開發(fā)工作的逐步延伸，具有一定的繼承關系，在一個項目各開發(fā)階段之間提供的文檔必定存在著可追溯的關系。例如，某一項軟件需求，必定在設計說明書、測試計劃、甚至用戶手冊中有所體現(xiàn)。必要時應能做到跟蹤追查。

    對于軟件評測師來說，文檔的編制還是比較重要的。大家加油！

    相關推薦：

  軟件評測師考試報名費用

  2015年下半年軟件評測師考試考試內(nèi)容

  軟考軟件測評師中軟件測試要點總結

  不會編程就做不好軟考測試師么？

  軟件測試的原則和經(jīng)驗分享