【文章內(nèi)容簡(jiǎn)介】 要性和規(guī)模 ） ， 并且要完成用戶手冊(cè) 、 操作手冊(cè)等面向用戶的文檔的編寫工作 ， 還要完成測(cè)試計(jì)劃的編制 。 在測(cè)試階段：該程序?qū)⒈蝗娴販y(cè)試 ， 已編制的文檔將被檢查審閱 。 一般要完成測(cè)試分析報(bào)告 。 作為開(kāi)發(fā)工作的結(jié)束 ， 所生產(chǎn)的程序 、文檔以及開(kāi)發(fā)工作本身將逐項(xiàng)被評(píng)價(jià) ， 最后寫出項(xiàng)目開(kāi)發(fā)總結(jié)報(bào)告 。 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所 @ by China Electronics Standardization Institute 計(jì)算機(jī)文檔編制 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所計(jì)算機(jī)文檔編制 在整個(gè)開(kāi)發(fā)過(guò)程中 （ 即前五個(gè)階段中 ） ，開(kāi)發(fā)團(tuán)隊(duì)要按月編寫開(kāi)發(fā)進(jìn)度月報(bào) 。 在運(yùn)行和維護(hù)階段 ， 軟件將在運(yùn)行使用中不斷地被維護(hù) ， 根據(jù)新提出的需求進(jìn)行必要而且可能的擴(kuò)充和刪改 、 更新和升級(jí) 。 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所 @ by China Electronics Standardization Institute 計(jì)算機(jī)文檔編制 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所計(jì)算機(jī)文檔編制 文檔編制中的考慮因素 文檔編制是開(kāi)發(fā)過(guò)程的有機(jī)組成部分 ， 也是一個(gè)不斷努力的工作過(guò)程 。 是一個(gè)從形成最初輪廓 、 經(jīng)反復(fù)檢查和修改 ， 直至程序和文檔正式交付使用的完整過(guò)程 。 其中每一步都要求工作人員做出很大努力 。 要保證文檔編制的質(zhì)量 ，要體現(xiàn)每個(gè)開(kāi)發(fā)項(xiàng)目的特點(diǎn) ， 也要注意不要花太多的人力 。 為此編制中要考慮如下各項(xiàng)因素 。 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所 @ by China Electronics Standardization Institute 計(jì)算機(jī)文檔編制 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所計(jì)算機(jī)文檔編制 文檔的讀者 每一種文檔都具有特定的讀者 。 這些讀者包括個(gè)人或小組 、 軟件開(kāi)發(fā)單位的成員或社會(huì)上的公眾 、 從事軟件工作的技術(shù)人員 、 管理人員或領(lǐng)導(dǎo)干部 。 他們期待著使用這些文檔的內(nèi)容來(lái)進(jìn)行工作 ， 例如設(shè)計(jì) 、 編寫程序 、 測(cè)試 、 使用 、 維護(hù)或進(jìn)行計(jì)劃管理 。 因此這些文檔的作者必須了解自己的讀者 。 這些文檔的編寫必須注意適應(yīng)自己的特定讀者的水平 、 特點(diǎn)和要求 。 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所 @ by China Electronics Standardization Institute 計(jì)算機(jī)文檔編制 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所計(jì)算機(jī)文檔編制 重復(fù)性 本規(guī)范中列出的文檔編制規(guī)范的內(nèi)容要求中 ， 顯然存在某些重復(fù) 。 較明顯的重復(fù)有兩類 。 引言是每一種文檔都要包含的內(nèi)容 ， 以向讀者提供總的梗概 .第二類明顯的重復(fù)是各種文檔中的說(shuō)明部分 ， 如對(duì)功能性能的說(shuō)明；對(duì)輸入 、 輸出的描述；系統(tǒng)中包含的設(shè)備等 。 這是為了方便每種文檔各自的讀者 ， 每種文檔應(yīng)該自成體系 ， 盡量避免讀一種文檔時(shí)又不得不去參考另一種文檔 。 當(dāng)然 ， 在每一種文檔里 ， 有關(guān)引言 、 說(shuō)明等同其他文檔相重復(fù)的部分 ， 在行文上 、 在所用的術(shù)語(yǔ)上 、 在詳細(xì)的程度上 ， 還是應(yīng)該有一些差別以適應(yīng)各種文檔的不同讀者的需要 。 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所 @ by China Electronics Standardization Institute 計(jì)算機(jī)文檔編制 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所計(jì)算機(jī)文檔編制 靈活性 鑒于軟件開(kāi)發(fā)是具有創(chuàng)造性的腦力勞動(dòng) ， 也鑒于不同軟件在規(guī)模上和復(fù)雜程度上差別極大 ，本規(guī)范認(rèn)為在文檔編制工作中應(yīng)允許一定的靈活性 。 這種靈活性表現(xiàn)在如下各款 。 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所 @ by China Electronics Standardization Institute 計(jì)算機(jī)文檔編制 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所計(jì)算機(jī)文檔編制 a. 應(yīng)編制的文檔種類 盡管本規(guī)范認(rèn)為在一般情況下 ， 一項(xiàng)軟件的開(kāi)發(fā)過(guò)程中 ， 應(yīng)產(chǎn)生如上所述的各種文檔 ， 然而針對(duì)一項(xiàng)具體的軟件開(kāi)發(fā)項(xiàng)目 ， 有時(shí)不必編制這么多的文檔 ， 可以把幾種文檔合并成一種 。一般地說(shuō) ， 當(dāng)項(xiàng)目的規(guī)模 、 復(fù)雜性和失敗風(fēng)險(xiǎn)增大時(shí) ， 文檔編制的范圍 ， 管理手續(xù)和詳細(xì)程度將隨之增加 ， 反之 ， 則可適當(dāng)減少 。 為了恰當(dāng)?shù)卣莆者@種靈活性 ， 本規(guī)范要求貫徹分工負(fù)責(zé)的原則 ， 這意味著： 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所 @ by China Electronics Standardization Institute 計(jì)算機(jī)文檔編制 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所計(jì)算機(jī)文檔編制 1） 一個(gè)軟件開(kāi)發(fā)單位的領(lǐng)導(dǎo)機(jī)構(gòu)應(yīng)該根據(jù)本單位經(jīng)營(yíng)承包的應(yīng)用軟件的專業(yè)領(lǐng)域和本單位的管理能力 ， 制定一個(gè)對(duì)文檔編制要求的實(shí)施規(guī)定 ， 主要是：在不同的條件下 ， 應(yīng)該形成哪些文檔 ？ 這些文檔的詳細(xì)程度 ？ 該開(kāi)發(fā)單位的每一個(gè)項(xiàng)目負(fù)責(zé)人 ， 必須認(rèn)真執(zhí)行這個(gè)實(shí)施規(guī)定 。 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所 @ by China Electronics Standardization Institute 計(jì)算機(jī)文檔編制 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所計(jì)算機(jī)文檔編制 2） 對(duì)于一個(gè)具體的應(yīng)用軟件項(xiàng)目 ，項(xiàng)目負(fù)責(zé)人應(yīng)根據(jù)上述實(shí)施規(guī)定 ， 確定一個(gè)文檔編制計(jì)劃 （ 可以包含在軟件開(kāi)發(fā)計(jì)劃中 ） ， 其中包括： 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所 @ by China Electronics Standardization Institute 計(jì)算機(jī)文檔編制 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所計(jì)算機(jī)文檔編制 （ 1） 應(yīng)該編制哪幾種文檔 ， 詳細(xì)程度如何 ？ (2) 各個(gè)文檔的編制負(fù)責(zé)人和進(jìn)度要求； (3) 審查 、 批準(zhǔn)的負(fù)責(zé)人和時(shí)間進(jìn)度安排 (4) 在開(kāi)發(fā)時(shí)間內(nèi) ， 各文檔的維護(hù) 、 修改和 管理的負(fù)責(zé)人 ， 以及批準(zhǔn)手續(xù) 。 每項(xiàng)工作必須落實(shí)到人 。 這個(gè)文件編制計(jì)劃是整個(gè)開(kāi)發(fā)計(jì)劃的重要組成部份 。 3） 有關(guān)的設(shè)計(jì)人員則必須嚴(yán)格執(zhí)行這個(gè)文檔編制計(jì)劃 。 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所 @ by China Electronics Standardization Institute 計(jì)算機(jī)文檔編制 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所計(jì)算機(jī)文檔編制 b. 文檔的詳細(xì)程度 從同一份提綱起草的文件的篇幅大小往往不同 ， 可以少到幾頁(yè) ， 也可以長(zhǎng)達(dá)幾百頁(yè) 。 對(duì)于這種差別 ， 本規(guī)范是允許的 。 此詳細(xì)程度取決于任務(wù)的規(guī)模 、 復(fù)雜性和項(xiàng)目負(fù)責(zé)人對(duì)該軟件的開(kāi)發(fā)過(guò)程及運(yùn)行環(huán)境所需要的詳細(xì)程度的判斷 。 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所 @ by China Electronics Standardization Institute 計(jì)算機(jī)文檔編制 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所計(jì)算機(jī)文檔編制 c. 文檔的擴(kuò)展 當(dāng)被開(kāi)發(fā)系統(tǒng)的規(guī)模非常大 〈 例如源碼超過(guò)一百萬(wàn)行 〉 時(shí) ， 一種文檔可以分成幾卷編寫 ，可以按其中每一個(gè)系統(tǒng)分別編制；也可以按內(nèi)容劃分成多卷 ， 例如： 項(xiàng)目開(kāi)發(fā)計(jì)劃可能包括： 質(zhì)量保證計(jì)劃 ， 配置管理計(jì)劃 ， 用戶培訓(xùn)計(jì)劃 ， 安裝實(shí)施計(jì)劃； 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所 @ by China Electronics Standardization Institute 計(jì)算機(jī)文檔編制 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所計(jì)算機(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ō)明； 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所 @ by China Electronics Standardization Institute 計(jì)算機(jī)文檔編制 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所計(jì)算機(jī)文檔編制 操作手冊(cè)可分寫成： 操作手冊(cè) ， 安裝實(shí)施過(guò)程； 測(cè)試計(jì)劃可分寫成： 測(cè)試計(jì)劃 ， 測(cè)試設(shè)計(jì)說(shuō)明 ， 測(cè)試規(guī)程 ， 測(cè)試用例； 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所 @ by China Electronics Standardization Institute 計(jì)算機(jī)文檔編制 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所計(jì)算機(jī)文檔編制 測(cè)試分析報(bào)告可分寫成： 綜合測(cè)試報(bào)告 ， 驗(yàn)收測(cè)試報(bào)告； 項(xiàng)目開(kāi)發(fā)總結(jié)報(bào)告亦可分寫成項(xiàng)目開(kāi)發(fā)總結(jié)報(bào)告和資源環(huán)境統(tǒng)計(jì) 。 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所 @ by China Electronics Standardization Institute 計(jì)算機(jī)文檔編制 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所計(jì)算機(jī)文檔編制 d. 節(jié)的擴(kuò)張與縮并 在有些文檔中 ， 可以使用本規(guī)范所提供的章 、條標(biāo)題 ， 有存在一系列需要分別討論的因素 。本規(guī)范認(rèn)為 ， 所有的條都可以擴(kuò)展 ， 可以進(jìn)一步細(xì)分 ， 以適應(yīng)實(shí)際需要 。 反之如果章條中的有些細(xì)節(jié)并非必需 ， 也可以根據(jù)實(shí)際情況縮并 。此時(shí)章條的編號(hào)應(yīng)相應(yīng)地變更 。 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所 @ by China Electronics Standardization Institute 計(jì)算機(jī)文檔編制 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所計(jì)算機(jī)文檔編制 e. 程序設(shè)計(jì)的表現(xiàn)形式 本規(guī)范對(duì)于程序的設(shè)計(jì)表現(xiàn)形式并未作出規(guī)定或限制 ， 可以使用流程圖的形式 ， 判定表的形式 ，也可以使用其他表現(xiàn)形式 ， 如程序設(shè)計(jì)語(yǔ)言（ PDL） 、 問(wèn)題分析圖 （ PALb） 等 。 f. 文檔的表現(xiàn)形式 本規(guī)范對(duì)于文檔的表現(xiàn)形式亦未作出規(guī)定或限制 。 可以使用自然語(yǔ)言 ， 也可以使用形式化語(yǔ)言 。也可以使用各件圖 、 表 。 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所 @ by China Electronics Standardization Institute 計(jì)算機(jī)文檔編制 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所計(jì)算機(jī)文檔編制七、文檔編制格式 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所 @ by China Electronics Standardization Institute 計(jì)算機(jī)文檔編制 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所計(jì)算機(jī)文檔編制 可行性分析（研究）報(bào)告（ FAR） 說(shuō)明： 1. 《 可行性分析 （ 研究 ） 報(bào)告 》 （ FAR）它是項(xiàng)目初期策劃的結(jié)果 ， 它分析了項(xiàng)目的要求 、 目標(biāo)和環(huán)境；提出了幾種可供選擇的方案；并從技術(shù) 、 經(jīng)濟(jì)和法律各方面進(jìn)行了可行性分析 。 可作為項(xiàng)目決策的依據(jù) 。 2. FAR也可以作為項(xiàng)目建議書 、 投標(biāo)書等文件的基礎(chǔ) 。 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所 @ by China Electronics Standardization Institute 計(jì)算機(jī)文檔編制 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所計(jì)算機(jī)文檔編制1 引言 本章分為以下幾條 。 標(biāo)識(shí) 本條應(yīng)包含本文檔適用的系統(tǒng)和軟件的完整標(biāo)識(shí) ， （ 若適用 ） 包括標(biāo)識(shí)號(hào) 、 標(biāo)題 、 縮略詞語(yǔ) 、版本號(hào)和發(fā)行號(hào) 。 背景 說(shuō)明項(xiàng)目在什么條件下提出 ， 提出者的要求 、目標(biāo) 、 實(shí)現(xiàn)環(huán)境和限制條件 。 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所 @ by China Electronics Standardization Institute 計(jì)算機(jī)文檔編制 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所計(jì)算機(jī)文檔編制 項(xiàng)目概述 本條應(yīng)簡(jiǎn)述本文檔適用的項(xiàng)目和軟件的用途 ， 它應(yīng)描述項(xiàng)目和軟件的一般特性；概述項(xiàng)目開(kāi)發(fā) 、 運(yùn)行和維護(hù)的歷史；標(biāo)識(shí)項(xiàng)目的投資方 、 需方 、 用戶 、 開(kāi)發(fā)方和支持機(jī)構(gòu)；標(biāo)識(shí)當(dāng)前和計(jì)劃的運(yùn)行現(xiàn)場(chǎng)；列出其它有關(guān)的文檔 。 文檔概述 本條應(yīng)概述本文檔的用途和內(nèi)容 ， 并描述與其使用有關(guān)的保密性和私密性的要求 。 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所 @ by China Electronics Standardization Institute 計(jì)算機(jī)文檔編制 中國(guó)電子技術(shù)標(biāo)準(zhǔn)化研究所計(jì)算機(jī)文檔編制2 引用文檔 本章應(yīng)列出本文檔引用的所有文檔的編號(hào) 、標(biāo)題 、 修訂版本和日期 ， 本章也應(yīng)標(biāo)識(shí)不能通過(guò)正常的供貨渠道獲得的所有文