軟件文檔寫(xiě)作01-概述-在線瀏覽
2025-07-15 20:20本頁(yè)面
【正文】 其為軟件 ， 也更不能成為軟件產(chǎn)品 。 如系統(tǒng)分析文檔 、 設(shè)計(jì)文檔 、 版本說(shuō)明文檔 …… 軟件文檔的規(guī)范編制 ， 在軟件開(kāi)發(fā)工作中占有突出的地位和相當(dāng)大的工作量 。 觀點(diǎn) ： “ 如果不記下來(lái) ， 它就并不存在 ” 。 文檔 —— 某種數(shù)據(jù)媒體和其中所記錄的數(shù)據(jù)。 文檔作為計(jì)算機(jī)軟件的重要組成部分，告訴用戶如何操作和維護(hù)系統(tǒng)，提供關(guān)于未來(lái)改進(jìn)和重新實(shí)施所需的信息，在開(kāi)發(fā)人員、維護(hù)人員、管理人員、用戶與計(jì)算機(jī)之間起著重要的橋梁作用。 2. 技術(shù)交流的語(yǔ)言 項(xiàng)目小組內(nèi)部 、 項(xiàng)目平行開(kāi)發(fā)的各小組之間進(jìn)行的交流和聯(lián)系 ， 通常都是通過(guò)文檔來(lái)實(shí)現(xiàn)的 。 16 4. 支持培訓(xùn)與維護(hù) 合格的軟件文檔通常都提供有關(guān)軟件運(yùn)行、維護(hù)和培訓(xùn)的必要信息，支持軟件產(chǎn)品的應(yīng)用和維護(hù)。 6. 記載軟件歷史 軟件文檔作為 “ 記載軟件歷史的語(yǔ)言 ” ，可用作未來(lái)項(xiàng)目的一種資源，向潛在用戶報(bào)道軟件的各種有利信息，便于他們判斷自己是否需要該軟件提供的服務(wù)。 17 軟件文檔的分類(lèi) 國(guó)家標(biāo)準(zhǔn)局在 1988年 1月頒布了 《 計(jì)算機(jī)軟件開(kāi)發(fā)規(guī)范 》和 《 計(jì)算機(jī)軟件產(chǎn)品開(kāi)發(fā)文件編制指南 》 ， 作為軟件開(kāi)發(fā)和文檔編制工作的準(zhǔn)則和規(guī)程 。 軟件文檔根據(jù)其產(chǎn)生和使用的范圍 ， 主要?jiǎng)澐譃?3大類(lèi)：開(kāi)發(fā)文檔 、 用戶文檔和管理文檔 。 軟件文檔的使用對(duì)象 開(kāi)發(fā)人員 維護(hù)人員 管理人員 用 戶 可行性研究報(bào)告 項(xiàng)目開(kāi)發(fā)計(jì)劃 軟件需求說(shuō)明書(shū) 數(shù)據(jù)要求說(shuō)明書(shū) 概要設(shè)計(jì)說(shuō)明書(shū) 詳細(xì)設(shè)計(jì)說(shuō)明書(shū) 數(shù)據(jù)庫(kù)設(shè)計(jì)說(shuō)明書(shū) 測(cè)試計(jì)劃 測(cè)試分析報(bào)告 設(shè)計(jì)說(shuō)明書(shū) 測(cè)試分析報(bào)告 模塊開(kāi)發(fā)卷宗 可行性研究報(bào)告 項(xiàng)目開(kāi)發(fā)計(jì)劃 模塊開(kāi)發(fā)卷宗 開(kāi)發(fā)進(jìn)度月報(bào) 項(xiàng)目開(kāi)發(fā)總結(jié)報(bào)告 用戶手冊(cè) 操作手冊(cè) 20 軟件文檔編制與軟件生存期的關(guān)系 軟件文檔的編制是隨著軟件生存期各個(gè)階段工作的開(kāi)展而適時(shí)進(jìn)行的 。 21 可行性研究與計(jì)劃 需求分析 軟件設(shè)計(jì) 編碼與單元測(cè)試 集成與測(cè)試 運(yùn)行與維護(hù) 可行性研究報(bào)告 √ 項(xiàng)目開(kāi)發(fā)計(jì)劃 √ √ 軟件需求說(shuō)明書(shū) √
范文總結(jié)相關(guān)推薦
鄂ICP備17016276號(hào)-1