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

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

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

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

    (3)清晰性：文檔編寫應(yīng)力求簡(jiǎn)明，如有可能，配以適當(dāng)?shù)膱D表，以增強(qiáng)其清晰性。

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

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

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

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

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

    對(duì)于一個(gè)具體的應(yīng)用軟件項(xiàng)目，項(xiàng)目負(fù)責(zé)人應(yīng)根據(jù)上述實(shí)施規(guī)定，確定一個(gè)文檔編制計(jì)劃。其中包括：

    應(yīng)該編制哪幾種文檔，詳細(xì)程度如何。

    各個(gè)文檔的編制負(fù)責(zé)人和進(jìn)度要求。

    審查、批準(zhǔn)的負(fù)責(zé)人和時(shí)間進(jìn)度安排。

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

    有關(guān)的開發(fā)人員必須嚴(yán)格執(zhí)行這個(gè)文檔編制計(jì)劃。

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

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

    系統(tǒng)設(shè)計(jì)說(shuō)明書可分寫為：系統(tǒng)設(shè)計(jì)說(shuō)明書、子系統(tǒng)設(shè)計(jì)說(shuō)明書。

    程序設(shè)計(jì)說(shuō)明書可分寫為：程序設(shè)計(jì)說(shuō)明書、接口設(shè)計(jì)說(shuō)明書、版本說(shuō)明。

    -操作手冊(cè)可分寫為：操作手冊(cè)、安裝實(shí)施過(guò)程。

    測(cè)試計(jì)劃可分寫為：測(cè)試計(jì)劃、測(cè)試設(shè)計(jì)說(shuō)明、測(cè)試規(guī)程、測(cè)試用例。

    測(cè)試分析報(bào)告可分寫為：綜合測(cè)試報(bào)告、驗(yàn)收測(cè)試報(bào)告。

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

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

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

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

    6)對(duì)于文檔的表現(xiàn)形式，沒(méi)有規(guī)定或限制?？梢允褂米匀徽Z(yǔ)言、也可以使用形式化的語(yǔ)言。

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

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

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

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

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

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

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

    對(duì)于軟件評(píng)測(cè)師來(lái)說(shuō)，文檔的編制還是比較重要的。大家加油！

    相關(guān)推薦：

  軟件評(píng)測(cè)師考試報(bào)名費(fèi)用

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

  軟考軟件測(cè)評(píng)師中軟件測(cè)試要點(diǎn)總結(jié)

  不會(huì)編程就做不好軟考測(cè)試師么？

  軟件測(cè)試的原則和經(jīng)驗(yàn)分享