軟件工程文檔寫作ppt課件-閱讀頁(yè)
2024-09-11 04:53本頁(yè)面
【正文】 計(jì)說說 明明 書書詳詳 細(xì)細(xì) 設(shè)設(shè) 計(jì)計(jì)說說 明明 書書用用 戶戶 手手 冊(cè)冊(cè)操操 作作 手手 冊(cè)冊(cè)測(cè)測(cè) 試試 分分 析析報(bào)報(bào) 告告開開 發(fā)發(fā) 進(jìn)進(jìn) 度度月月 報(bào)報(bào)ww hh aa tt ww hh ee rr ee ww hh ee nn ww hh oo hh oo ww ww hh yy項(xiàng)項(xiàng) 目目 開開 發(fā)發(fā)總總 結(jié)結(jié)程程 序序 維維 護(hù)護(hù)手手 冊(cè)冊(cè) (( 維維護(hù)護(hù) 修修 改改 建建議議 ))對(duì)文檔編制的質(zhì)量要求 ? 如果不重視文檔編寫工作，或是對(duì)文檔編寫工作的安排不當(dāng)，就不可能得到高質(zhì)量的文檔。按不同的類型、不同層次的讀者，決定怎樣適應(yīng)他們的需要。 (2) 精確性 ? 文檔的行文應(yīng)當(dāng) 十分確切 ， 不能出現(xiàn)多義性的描述 。 (3) 清晰性 ? 文檔編寫應(yīng) 力求簡(jiǎn)明 ， 如有可能，配以適當(dāng)?shù)膱D表，以增強(qiáng)其清晰性。 ? 例如， 前言部分應(yīng)做一般性介紹，正文給出中心內(nèi)容，必要時(shí)還有附錄，列出參考資料等。 ? 不要在文檔中出現(xiàn)轉(zhuǎn)引其它文檔內(nèi)容的情況 。 ? 應(yīng)根據(jù)具體的軟件開發(fā)項(xiàng)目，決定編制的文檔種類。 ? 對(duì)于一個(gè)具體的應(yīng)用軟件項(xiàng)目，項(xiàng)目負(fù)責(zé)人應(yīng)根據(jù)上述實(shí)施規(guī)定，確定一個(gè)文檔編制計(jì)劃。 例如， ? 項(xiàng)目開發(fā)計(jì)劃 可分寫為： ? 質(zhì)量保證計(jì)劃 ? 配置管理計(jì)劃 ? 用戶培訓(xùn)計(jì)劃 ? 安裝實(shí)施計(jì)劃等 。 ? 程序設(shè)計(jì)說明書 可分寫為： ? 程序設(shè)計(jì)說明書 ? 接口設(shè)計(jì)說明書 ? 版本說明。 ? 測(cè)試計(jì)劃 可分寫為： ? 測(cè)試計(jì)劃 ? 測(cè)試設(shè)計(jì)說明 ? 測(cè)試規(guī)程 ? 測(cè)試用例。 ? 項(xiàng)目開發(fā)總結(jié)報(bào)告 也可分寫成： ? 項(xiàng)目開發(fā)總結(jié)報(bào)告 ? 資源環(huán)境統(tǒng)計(jì)。 ? 程序的設(shè)計(jì)表現(xiàn)形式，可以使用 程序流程圖 、 判定表 、 程序描述語言 (PDL)、或 問題分析圖 (PAD)等。 ? 為使軟件文檔能起到多種橋梁的作用： ? 有助于程序員編制程序 ? 有助于管理人員監(jiān)督和管理軟件的開發(fā) ? 有助于用戶了解軟件的工作和應(yīng)做的操作， ? 有助于維護(hù)人員進(jìn)行有效的修改和擴(kuò)充 ? 文檔的編制必須保證一定的質(zhì)
范文總結(jié)相關(guān)推薦
鄂ICP備17016276號(hào)-1