【文章內(nèi)容簡(jiǎn)介】 軟件，源碼行數(shù)約 10000～ 50000； (3) 大規(guī)模軟件，源碼行數(shù)約 100000～ 500000； (4) 超大規(guī)模軟件，源碼行數(shù)大于 500000。 對(duì)此，相應(yīng)規(guī)模軟件應(yīng)該編制的文檔種類(lèi)，參見(jiàn)下表： 小規(guī)模軟件 中規(guī)模軟件 大規(guī)模軟件 超大規(guī)模軟件 軟件需求與開(kāi)發(fā)計(jì)劃 項(xiàng)目開(kāi)發(fā)計(jì)劃 可行性報(bào)告 對(duì)應(yīng)大規(guī)模軟件所規(guī)定的文檔種類(lèi)，再做進(jìn)一步細(xì)分 項(xiàng)目開(kāi)發(fā)計(jì)劃 軟件需求說(shuō)明 軟件需求說(shuō)明 數(shù)據(jù)要求說(shuō)明 測(cè)試計(jì)劃 測(cè)試計(jì)劃 軟件設(shè)計(jì)說(shuō)明 軟件設(shè)計(jì)說(shuō)明 概要設(shè)計(jì)說(shuō)明 詳細(xì)設(shè)計(jì)說(shuō)明 數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明 使用說(shuō)明 使用說(shuō)明 用戶(hù)手冊(cè) 操作手冊(cè) 測(cè)試分析報(bào)告 模塊開(kāi)發(fā)卷宗 模塊開(kāi)發(fā)卷宗 測(cè)試分析報(bào)告 測(cè)試分析報(bào)告 項(xiàng)目開(kāi)發(fā)總結(jié) 開(kāi)發(fā)進(jìn)度月報(bào) 開(kāi)發(fā)進(jìn)度月報(bào) 項(xiàng)目開(kāi)發(fā)總結(jié) 項(xiàng)目開(kāi)發(fā)總結(jié) 軟件文檔的編寫(xiě)步驟 四個(gè)步驟： ① 準(zhǔn)備工作 ② 確定寫(xiě)作內(nèi)容 ③ 編寫(xiě)定稿 ④ 更新完善 如何寫(xiě)好計(jì)算機(jī)軟件文檔 做好準(zhǔn)備 講究文風(fēng) 注重表達(dá) 加強(qiáng)文檔編寫(xiě)使用的組織管理 文檔寫(xiě)作中值得注意的幾個(gè)問(wèn)題 做好準(zhǔn)備 在理解系統(tǒng)和用戶(hù)方面主要應(yīng)解決三個(gè)問(wèn)題： 第一，理解目標(biāo)系統(tǒng)； 第二，理解用戶(hù) (這里的用戶(hù)包含兩層含義：其一是計(jì)算機(jī)系統(tǒng)用戶(hù)，其二是有關(guān)計(jì)算機(jī)軟件文檔的讀者或使用者）； 第三，將對(duì)系統(tǒng)和用戶(hù)的理解進(jìn)行分析比較。 (1)不同的編寫(xiě)目的要求不同的編寫(xiě)方法 (2)不同讀者對(duì)文檔有不同要求 ?以系統(tǒng)分析設(shè)計(jì)人員為主要讀者的文檔。這類(lèi)文檔主要有系統(tǒng)原始模型、系統(tǒng)分析報(bào)告、系統(tǒng)需求說(shuō)明等。這類(lèi)讀者一般包括用戶(hù)的高層人員和計(jì)算機(jī)系統(tǒng)設(shè)計(jì)開(kāi)發(fā)的高層人員。編寫(xiě)這類(lèi)文檔特別需要注意的問(wèn)題是：保證所編寫(xiě)文檔必須讓用戶(hù)和計(jì)算機(jī)人員都能全面正確地理解其含義，并保證無(wú)二義性。此時(shí)必須注意用詞的內(nèi)含與外延的一致，盡量少用專(zhuān)業(yè)詞語(yǔ)。 ?以系統(tǒng)開(kāi)發(fā)人員為主要讀者的文檔。這類(lèi)文檔主要有系統(tǒng)概要設(shè)計(jì)、系統(tǒng)詳細(xì)設(shè)計(jì)等。這類(lèi)讀者不同程度地具有一定的計(jì)算機(jī)專(zhuān)業(yè)知識(shí)和技能，對(duì)系統(tǒng)所處理的內(nèi)容和用戶(hù)的有關(guān)情況了解相對(duì)較少。編寫(xiě)這類(lèi)文檔時(shí)，對(duì)計(jì)算機(jī)方面的有關(guān)敘述可以完全采用專(zhuān)業(yè)術(shù)語(yǔ)，不必有過(guò)多過(guò)細(xì) 的解釋?zhuān)鴮?duì)涉及系統(tǒng)處理對(duì)象及用戶(hù)方面的內(nèi)容應(yīng)寫(xiě)得較全面詳細(xì)。 ?以系統(tǒng)維護(hù)人員為主要讀者的文檔。這類(lèi)文檔主要指系統(tǒng)維護(hù)文檔等，讀者一般包括計(jì)算機(jī)專(zhuān)業(yè)人員和用戶(hù)兩類(lèi)。這類(lèi)文檔必須提供系統(tǒng)總體功能及每一個(gè)具體功能實(shí)現(xiàn)的細(xì)節(jié)，并保證可讀性，必要的話(huà)應(yīng)提供系統(tǒng)流程、數(shù)據(jù)流程等更為詳盡的資料。必須做到通過(guò)閱讀這類(lèi)文檔可以全面、準(zhǔn)確、詳細(xì)地理解系統(tǒng)的有關(guān)情況，同時(shí)注意專(zhuān)業(yè)性與通俗性并重。 ?以系統(tǒng)使用人員為主要讀者的文檔。這類(lèi)文檔主要指用戶(hù)手冊(cè)、參考手冊(cè)、操作手冊(cè)及用于宣傳系統(tǒng)情況的文檔等，這類(lèi)文檔可稱(chēng)為用戶(hù)文檔。這類(lèi)文檔必須克服用戶(hù)的畏懼心理，樹(shù)立用戶(hù)的信任感，提供容易遵循和理解的說(shuō)明，必須從用戶(hù)角度出發(fā)，使用較為淺顯而準(zhǔn)確的語(yǔ)言，做到行文流暢，并注意使用例子。 (1)標(biāo)準(zhǔn)與約定 (2)確定表達(dá)方式 需要編入文檔的資料以怎樣的方式表達(dá)，對(duì)該文檔涉眾以及軟件產(chǎn)品、文檔等的傳播有很大的影響。 以軟件產(chǎn)品的 用戶(hù)手冊(cè) 為例 ， 其表達(dá)方式有以下多種： 1. 直敘式 2. 菜譜式 3. 編號(hào)指令式 4. 劇本式 5. 四步法 任何一本軟件用戶(hù)手冊(cè)都可能使用這些方法的其中一種或幾種 。 用戶(hù)手冊(cè) 編制時(shí)常用表達(dá)方式介紹： 。 按照文檔中上下文關(guān)系 ， 平鋪直敘需要編入文檔的內(nèi)容 。 這是多數(shù)文檔常用的表達(dá)形式 。 下圖是一個(gè)直敘式編檔的例子： 訂購(gòu)員填寫(xiě)訂購(gòu)輸入單 (單據(jù)編號(hào) P0123)， 這張單據(jù)有預(yù)先印好的訂購(gòu)號(hào) 。 事務(wù)員輸入日期 、 供貨公司名 、 貨號(hào) 、 數(shù)量和價(jià)格 。 事務(wù)員將此單據(jù)信息輸入到計(jì)算機(jī)中 ， 并更新訂購(gòu)文件 。 注意這種方式會(huì)使某些信息在段落中丟失且無(wú)重點(diǎn)。可以把它和下一種表達(dá)方式的例子加以比較 2. 菜譜方式。 菜譜方式，顧名思義，就是寫(xiě)成菜肴或點(diǎn)心的烹制法的樣子： 攪拌直至均勻，并出現(xiàn)泡沫為止 焙烤 (350176。 )一小時(shí) 語(yǔ)句的第一個(gè)詞是動(dòng)詞。菜譜方式可以比直敘方式使用更少的字詞表達(dá)數(shù)學(xué)內(nèi)容。 將前面直敘方式表達(dá)的內(nèi)容用菜譜方式再表達(dá)一次。同樣的內(nèi)容，字?jǐn)?shù)少了，但實(shí)際上說(shuō)的是同一件事。閱讀行越短，意味著閱讀和理解越快。 填寫(xiě)訂購(gòu)輸入單， P0123 輸入日期、供貨公司名、貨號(hào)、數(shù)量和價(jià)格 將單據(jù)數(shù)據(jù)錄入計(jì)算機(jī) 更新訂購(gòu)文件 3. 編號(hào)指令式 。以菜譜式為基礎(chǔ)，將文檔中描述的軟件工作步驟或處理過(guò)程加以編號(hào)，其表達(dá)結(jié)果會(huì)比直敘式更適合閱讀理解。 訂購(gòu)員填好訂購(gòu)輸入單 (P0123)。 1. 訂購(gòu)號(hào)：已印在單據(jù)上 2. 日期：輸入當(dāng)前日期。采用 yyyymmdd的 8位表達(dá)，如將 2022年 12月 2日表示為 20221202 3. 供貨企業(yè)：輸入接受訂貨的企業(yè)名。最多 25個(gè)漢字 4. 貨號(hào)：輸入要訂購(gòu)的貨號(hào) 。 在庫(kù)存清單中找貨號(hào) 。 若為新增 ，則見(jiàn)新增貨物部分 5. 數(shù)量：輸入訂購(gòu)數(shù)量 。 最多 99999 6. 單價(jià)：輸入每種貨物的價(jià)格 。 最貴 ￥ (系統(tǒng)將計(jì)算本次訂購(gòu)的總金額 ) 7. 制表人：制表人簽名 8. 計(jì)算機(jī)操作員把填寫(xiě)完畢的訂購(gòu)單送計(jì)算機(jī)錄入 9. 系統(tǒng)管理員將錄入后數(shù)據(jù)處理 ， 并更新訂購(gòu)文件 這種表達(dá)方式使需要完成的工作十分明確，且數(shù)據(jù)的長(zhǎng)度、格式也有規(guī)定，盡管占用的空間稍大，但閱讀方便，能使讀者快速找到需要的內(nèi)容。 4. 劇本式。 以菜譜式為基礎(chǔ)，將文檔以劇本方式表達(dá)。也有“ 演員 ” ，以及動(dòng)作。下圖是這種方法的例： 訂購(gòu)員： 1. 完成訂購(gòu)輸入單 (P0123) a. 訂購(gòu)號(hào)： 預(yù)先印在單據(jù)上的順序號(hào)