信息系統(tǒng)的管理課件

信息系統(tǒng)的文檔，是系統(tǒng)建設(shè)過程的“痕跡”，是系統(tǒng)維護人員的指南，是開發(fā)人員與用戶交流的工具。規(guī)范的文檔意味著系統(tǒng)是按照工程化開發(fā)的，意味著信息系統(tǒng)的質(zhì)量有了形式上的保障。文檔的欠缺、文檔的隨意性和文檔的不規(guī)范，極有可能導(dǎo)致原來的開發(fā)人員流動以后，系統(tǒng)不可以維護、不可以升級，變成一個沒有擴展性、沒有生命力的系統(tǒng)。所以，為了建立一個良好的信息系統(tǒng)，不僅要充分利用各種現(xiàn)代化信息技術(shù)和正確的系統(tǒng)開發(fā)方法，同時還要做好文檔的管理工作。

本節(jié)主要討論的內(nèi)容：一、信息系統(tǒng)文檔的作用與類型二、信息系統(tǒng)各類文檔的內(nèi)容三、信息系統(tǒng)文檔的編制與管理

第八章、信息系統(tǒng)的文檔管理信息系統(tǒng)的文檔，是系統(tǒng)建設(shè)過程的“痕跡”，是系統(tǒng)維護人員1一、信息系統(tǒng)文檔的作用與類型

在軟件工程的學(xué)科領(lǐng)域里，文檔和程序加在一起被合稱為軟件。文檔與程序的區(qū)別在于前者是人可讀的，后者主要是機器用來執(zhí)行的。如果將源程序加上注釋，也可稱為文檔的一部分。本節(jié)主要介紹：l、信息系統(tǒng)文檔的作用2、信息系統(tǒng)文檔的類型

一、信息系統(tǒng)文檔的作用與類型 在軟件工程的學(xué)科領(lǐng)域里，2l、信息系統(tǒng)文檔的作用

這里指的信息系統(tǒng)的文檔，不但包括應(yīng)用軟件開發(fā)過程中產(chǎn)生的文檔，還包括硬件采購和網(wǎng)絡(luò)設(shè)計中形成的文檔；不但包括上述有一定格式要求的規(guī)范文檔，也包括系統(tǒng)建設(shè)過程中的各種來往文件、會議紀(jì)要、會計單據(jù)等資料形成的不規(guī)范文檔，后者是建設(shè)各方談判甚至索賠的重要依據(jù)。顯然，文檔的含義在信息系統(tǒng)學(xué)科領(lǐng)域里比軟件工程學(xué)科寬泛。

所以文檔是軟件的一部分，更是信息系統(tǒng)的一部分。沒有文檔的軟件，不稱其為合格的軟件；沒有文檔的信息系統(tǒng)，不稱其為完整的信息系統(tǒng)。l、信息系統(tǒng)文檔的作用這里指的信息系統(tǒng)的文檔，不但包括應(yīng)3

文檔在系統(tǒng)開發(fā)人員、項目管理人員、系統(tǒng)維護人員、系統(tǒng)評價人員以及用戶之間的多種橋梁作用可從圖

8-1中看出。圖8-1中列出了文檔在信息系統(tǒng)建設(shè)和運行過程中的七種典型溝通作用：文檔用戶開發(fā)人員前期開發(fā)人員開發(fā)人員開發(fā)人員開發(fā)人員用戶系統(tǒng)開發(fā)人員項目管理人員后期開發(fā)人員測試人員用戶維護人員維護人員圖8-1信息系統(tǒng)文檔的溝通作用圖文檔在系統(tǒng)開發(fā)人員、項目管理人員、系統(tǒng)維護人員、系統(tǒng)評價4（1）用戶與系統(tǒng)分析人員在系統(tǒng)規(guī)劃和系統(tǒng)分析階段通過文檔進(jìn)行溝通。（2）人員與項目管理人員通過文檔在項目期內(nèi)進(jìn)行溝通。（3）前期開發(fā)人員與后期開發(fā)人員通過書面文檔進(jìn)行溝通。（4）系統(tǒng)測試人員與系統(tǒng)開發(fā)人員通過文檔進(jìn)行溝通。（5）系統(tǒng)開發(fā)人員與用戶在系統(tǒng)運行期間進(jìn)行溝通。（6）系統(tǒng)開發(fā)人員與系統(tǒng)維護人員通過文檔進(jìn)行溝通。（7）用戶與維護人員在運行維護期間進(jìn)行溝通。

上述七個方面是文檔在溝通方面的主要作用，其實，文檔還可以作為監(jiān)理和審計的對象，作為開發(fā)其他信息系統(tǒng)的參照。（1）用戶與系統(tǒng)分析人員在系統(tǒng)規(guī)劃和系統(tǒng)分析階段通過文檔進(jìn)行5

如果發(fā)生合同糾紛，文檔還能體現(xiàn)出證據(jù)的作用。因為每份文檔都是項目建設(shè)中有關(guān)成員的一種書面承諾。絕大多數(shù)文檔都是需要簽名的。而簽名就表示對自己所簽署的那部分文檔內(nèi)容的認(rèn)可和承擔(dān)責(zé)任。特別是用戶提出的需求變更申請書必須妥善保管，這些文件在發(fā)生糾紛時往往能成為保護自己甚至索賠的重要依據(jù)。顯然，文檔的編制在信息系統(tǒng)的開發(fā)工作中占有突出的地位和相當(dāng)?shù)墓ぷ髁俊８咝?、高質(zhì)量地寫作、分發(fā)、管理和維護文檔對于充分發(fā)揮信息系統(tǒng)的效益有著重要意義。如果發(fā)生合同糾紛，文檔還能體現(xiàn)出證據(jù)的作用。因為每份文檔62、信息系統(tǒng)文檔的類型

信息系統(tǒng)的文檔有許多種分類方法：（1）按照產(chǎn)生頻率分為一次性文檔和非一次性文檔。前者如系統(tǒng)分析說明書、系統(tǒng)設(shè)計說明書等，后者如開發(fā)過程中用戶提交的需求變更申請書。非一次性文檔還可以分為頻率固定文檔和頻率不固定文檔，頻率固定文檔有項目組月度開發(fā)報告、信息系統(tǒng)運行日志、運行月報等，頻率不固定文檔有會計單據(jù)、需求變更申請書、維護修改建議書等。 一次性文檔和頻率固定的文檔一般都有較固定的內(nèi)容和格式，而頻率不固定的文檔由于發(fā)生的隨機性，導(dǎo)致文檔記錄人員在撰寫文檔時的隨意性。為了管理好這些頻率不固定的文檔，需要對這些文檔予以編號，并盡可能地統(tǒng)一格式，以便做到規(guī)范管理。2、信息系統(tǒng)文檔的類型信息系統(tǒng)的文檔有許多種分類方法：7（2）按照信息系統(tǒng)生命周期的階段不同，可以劃分為：系統(tǒng)規(guī)劃階段文檔，如系統(tǒng)可行性研究報告、項目開發(fā)計劃書等；系統(tǒng)分析階段的文檔，如系統(tǒng)分析說明書等；系統(tǒng)設(shè)計階段的文檔，如系統(tǒng)設(shè)計說明書、需求變更申請書等；系統(tǒng)實現(xiàn)階段的文檔，如程序設(shè)計報告、系統(tǒng)測試報告、開發(fā)總結(jié)報告等；系統(tǒng)運行與維護階段的文檔，如用戶手冊、操作手冊與維護修改建議書等。本書的附錄——國家標(biāo)準(zhǔn)《計算機軟件產(chǎn)品開發(fā)文件編制指南》基本上是按照軟件的生命周期進(jìn)行講解的，可以作為信息系統(tǒng)文檔的參照。（2）按照信息系統(tǒng)生命周期的階段不同，可以劃分為：系統(tǒng)規(guī)劃階8（3）按照文檔不同的服務(wù)目的，可以將信息系統(tǒng)的文檔分為三類：用戶文檔、開發(fā)文檔與管理文檔。用戶文檔主要是為用戶服務(wù)的，開發(fā)文檔主要是為開發(fā)人員服務(wù)的，管理文檔主要是為項目管理人員服務(wù)的。上述三種文檔的內(nèi)容參見圖8-2。當(dāng)然，圖中的分類不是絕對的，比如項目開發(fā)計劃對于開發(fā)人員來講很重要；測試計劃和測試報告對于管理人員來講也很重要。這里要強調(diào)項目管理文檔的重要性。項目管理文檔是對項目計劃、費用和問題進(jìn)行監(jiān)督的管理手段和項目建設(shè)過程進(jìn)行記錄的工具。這能使各級管理部門對項目的進(jìn)展保持預(yù)見性，以便能及時發(fā)現(xiàn)和處理系統(tǒng)開發(fā)及維護過程中出現(xiàn)的問題。（3）按照文檔不同的服務(wù)目的，可以將信息系統(tǒng)的文檔分為三類：9信息系統(tǒng)的文檔用戶文檔開發(fā)文檔管理文檔用戶手冊操作手冊運行日志/月報維護修改建議書系統(tǒng)分析說明系統(tǒng)設(shè)計說明程序設(shè)計說明測試計劃測試報告可行性研究報告項目開發(fā)計劃需求變更申請書開發(fā)進(jìn)度月報開發(fā)總結(jié)報告圖8-2按照服務(wù)目的不同劃分的文檔類型信息系統(tǒng)用戶文檔開發(fā)文檔管理文檔用戶手冊圖8-2按照服務(wù)目10二、信息系統(tǒng)各類文檔的內(nèi)容

盡管文檔的重要性大家都大體知道，但在實際工作中，文檔在編制和使用中仍然存在著許多問題，有待于解決。系統(tǒng)開發(fā)人員中較普遍地存在著對編制文檔不感興趣的現(xiàn)象。從用戶方面看，他們又常常抱怨：文檔售價太高、文檔不夠完整、文檔編寫得不好、文檔已經(jīng)陳舊或是文檔太多，難以使用，等等。各類文檔究竟應(yīng)該寫哪些內(nèi)容，說明什么問題，下面將大體按照信息系統(tǒng)生命周期的階段，逐一介紹上面提到的各種文檔。由于信息系統(tǒng)的分析與設(shè)計在信息系統(tǒng)的建設(shè)過程中非常重要，所以在對所有文檔分別進(jìn)行簡單介紹后，專門給出了系統(tǒng)分析說明書和系統(tǒng)分析說明書的內(nèi)容與參考格式。 二、信息系統(tǒng)各類文檔的內(nèi)容盡管文檔的重要性大家都大體知11本節(jié)內(nèi)容:1、系統(tǒng)各類文檔的內(nèi)容簡介2、系統(tǒng)分析說明書編寫指南3、系統(tǒng)設(shè)計說明書內(nèi)容指南本節(jié)內(nèi)容:12l、系統(tǒng)各類文檔的內(nèi)容簡介

信息系統(tǒng)建設(shè)過程中主要文檔有：系統(tǒng)開發(fā)立項報告、可行性研究報告、系統(tǒng)開發(fā)計劃書、系統(tǒng)分析說明書、系統(tǒng)設(shè)計說明書、程序設(shè)計報告、系統(tǒng)測試計劃與測試報告、系統(tǒng)使用與維護手冊、系統(tǒng)評價報告、系統(tǒng)開發(fā)月報與系統(tǒng)開發(fā)總結(jié)報告。下面對它們逐一介紹：l、系統(tǒng)各類文檔的內(nèi)容簡介 信息系統(tǒng)建設(shè)過程中主要文檔有13（1）系統(tǒng)開發(fā)立項報告

在信息系統(tǒng)的正式開發(fā)前。用戶單位必須提出要開發(fā)的新系統(tǒng)的目標(biāo)、功能、費用、時間、對組織機構(gòu)的影響等。如果是本單位獨立開發(fā)或聯(lián)合開發(fā)，這些內(nèi)容形成的文檔稱做立項報告，用于向領(lǐng)導(dǎo)申請經(jīng)費及支持等；如果是委托開發(fā)，則以任務(wù)委托或開發(fā)協(xié)議(合同)方式進(jìn)行說明。立項報告主要包括以下內(nèi)容：①概述：概述現(xiàn)行系統(tǒng)的組織結(jié)構(gòu)、功能、業(yè)務(wù)流程以及存在的主要問題。②新系統(tǒng)的目標(biāo)：開發(fā)新系統(tǒng)的意義和新系統(tǒng)實現(xiàn)后的功能、技術(shù)指標(biāo)、安全和保密性、新系統(tǒng)運行環(huán)境等。③經(jīng)費預(yù)算和經(jīng)費來源。④項目進(jìn)度和完成期限。⑤驗收標(biāo)準(zhǔn)和方法。⑥移交的文檔資料。⑦開始可行性研究的組織隊伍、機構(gòu)與預(yù)算。⑧其他有關(guān)需要說明的問題。（1）系統(tǒng)開發(fā)立項報告14（2）可行性研究報告

可行性研究階段的文檔是可行性研究報告。在可行性研究報告中要說明待開發(fā)項目在技術(shù)上、經(jīng)濟上和社會因素上的可行性，評述為了合理地達(dá)到開發(fā)目標(biāo)可供選擇的各種可能實施的方案，說明并論證所選定實施方案的理由?？尚行匝芯繄蟾嬷饕ㄒ韵聝?nèi)容：①概述。②新系統(tǒng)的目標(biāo)、要求和約束。③可行性研究的基本準(zhǔn)則。④現(xiàn)行系統(tǒng)描述及現(xiàn)行系統(tǒng)存在的主要問題。⑤新系統(tǒng)對現(xiàn)行系統(tǒng)的影響。⑥投資和效益分析。⑦其他可選方案及與國內(nèi)外同類方案的比較。⑧有關(guān)建議。（2）可行性研究報告15（3）系統(tǒng)開發(fā)計劃書

可行性報告被批準(zhǔn)后及在系統(tǒng)開發(fā)之前，需要擬定一份較為詳細(xì)的系統(tǒng)開發(fā)計劃，以保證系統(tǒng)開發(fā)工作按計劃保質(zhì)保量按時完成。在開始計劃書中，應(yīng)該說明各任務(wù)的負(fù)責(zé)人員、開發(fā)的進(jìn)度、開發(fā)經(jīng)費的預(yù)算、所需的硬什及軟件資源等。開發(fā)計劃書應(yīng)提供給項目管理人員，作為開發(fā)階段評審的參考。對于項目計劃的管理，可以采用MicrosoftProject等項目管理軟件進(jìn)行輔助管理。系統(tǒng)開發(fā)計劃書的主要內(nèi)容如下：

①概述：主要包括系統(tǒng)開發(fā)的主要目標(biāo)、基本方針、參加人員、工作階段和內(nèi)容等。②開發(fā)計劃：系統(tǒng)開發(fā)各工作階段或子項目的任務(wù)、分工、負(fù)責(zé)人、計劃時間(開始及結(jié)束時間)、人力與資金及設(shè)備消耗、實際執(zhí)行情況等?？捎霉ぷ鬟M(jìn)度表、甘特圖、網(wǎng)絡(luò)圖及關(guān)鍵路徑法等工具輔助管理。③驗收標(biāo)準(zhǔn)：每項工作完成后驗收的標(biāo)準(zhǔn)(時間、資金、質(zhì)量等)。④協(xié)調(diào)方法：信息系統(tǒng)開發(fā)中各個單位、階段之間的銜接、協(xié)調(diào)的方法、負(fù)責(zé)人、權(quán)限等。（3）系統(tǒng)開發(fā)計劃書16（4）系統(tǒng)分析說明書當(dāng)信息系統(tǒng)的開發(fā)采用委托方式進(jìn)行開發(fā)時，用戶需求說明書(或叫用戶需求報告)是開發(fā)單位與用戶間交流的橋梁，同時也是系統(tǒng)設(shè)計的基礎(chǔ)和依據(jù)。當(dāng)采用獨立開發(fā)或合作開發(fā)時，系統(tǒng)分析是系統(tǒng)開發(fā)中最重要的工作，其工作成果就是系統(tǒng)分析說明書(或叫系統(tǒng)分析報告)。系統(tǒng)分析工作的好壞決定了新系統(tǒng)的成敗。從信息系統(tǒng)生命周期的角度來看，用戶需求說明書就是系統(tǒng)分析說明書。系統(tǒng)分析說明書的主要內(nèi)容一般包括：①概述。②系統(tǒng)需求。③新系統(tǒng)目標(biāo)與新系統(tǒng)的功能。④新系統(tǒng)的邏輯模型。⑤新系統(tǒng)的運行環(huán)境。⑥新系統(tǒng)的驗收標(biāo)準(zhǔn)與培訓(xùn)計劃。（4）系統(tǒng)分析說明書17（5）系統(tǒng)設(shè)計說明書

在系統(tǒng)分析的基礎(chǔ)上，根據(jù)系統(tǒng)分析說明書進(jìn)行新系統(tǒng)的物理設(shè)計，并完成系統(tǒng)設(shè)計說明書(或叫系統(tǒng)設(shè)計報告)的撰寫。系統(tǒng)設(shè)計說明書主要包括以下內(nèi)容：①概述。 ⑥輸入與輸出設(shè)計。②總體結(jié)構(gòu)。 ⑦計算機處理過程設(shè)計。③計算機系統(tǒng)配置。⑧接口及通信環(huán)境設(shè)計。④代碼設(shè)計。 ⑨安全和保密設(shè)計。⑤數(shù)據(jù)庫設(shè)計。 ⑩數(shù)據(jù)準(zhǔn)備。

（5）系統(tǒng)設(shè)計說明書18（6）程序設(shè)計報告

依據(jù)系統(tǒng)設(shè)計報告，進(jìn)行程序設(shè)計工作。程序設(shè)計經(jīng)調(diào)試通過后，應(yīng)完成程序設(shè)計報告，以便為系統(tǒng)調(diào)試和系統(tǒng)維護工作提供依據(jù)。有了程序設(shè)計報告，就可以避免因程序員的流動造成系統(tǒng)維護工作的困難。程序設(shè)計報告的主要內(nèi)容如下：①概述。 ⑤程序流程圖。②程序結(jié)構(gòu)圖。 ⑥源程序。③程序控制圖。 ⑦程序注釋說明。④算法。（6）程序設(shè)計報告19（7）系統(tǒng)測試計劃與測試報告為做好組裝測試和確認(rèn)測試，需為如何組織測試制定實施計劃。測試計劃應(yīng)包括測試的內(nèi)容、進(jìn)度、條件、人員、測試用例的選取原則、測試結(jié)果允許的偏差范圍等。測試工作完成以后，應(yīng)提交測試計劃執(zhí)行情況的說明。對測試結(jié)果加以分析，并提出測試的結(jié)論意見。系統(tǒng)測試是系統(tǒng)實施階段的重要工作。系統(tǒng)測試報告主要內(nèi)容如下：①概述：說明系統(tǒng)測試的目的。②測試環(huán)境：有關(guān)軟硬件、通信、數(shù)據(jù)庫、人員等情況。③測試內(nèi)容：系統(tǒng)、子系統(tǒng)、模塊的名稱，性能技術(shù)指標(biāo)等。④測試方案：測試的方法、測試數(shù)據(jù)、測試步驟、測試中故障的解決方案等。⑤測試結(jié)果：測試的實際情況、結(jié)果等。⑥結(jié)論：系統(tǒng)功能評價、性能技術(shù)指標(biāo)評價、結(jié)論。（7）系統(tǒng)測試計劃與測試報告20（8）系統(tǒng)使用與維護手冊

系統(tǒng)使用與維護手冊是為用戶準(zhǔn)備的文檔。有的系統(tǒng)比較大，將使用手冊與維護手冊分開。其中，系統(tǒng)使用手冊(或叫操作手冊)一般是面向業(yè)務(wù)人員的，他們是系統(tǒng)的最終使用者。系統(tǒng)維護手冊(或叫技術(shù)手冊)是供具有一定信息技術(shù)專業(yè)知識的系統(tǒng)維護人員使用的。系統(tǒng)使用與維護手冊的主要內(nèi)容包括：①概述：主要包括系統(tǒng)功能、系統(tǒng)運行環(huán)境(軟、硬件)、系統(tǒng)安裝等內(nèi)容。②使用說明：系統(tǒng)操作使用說明較為詳細(xì)地說明了操作的目的、過程、方式、輸入輸出的數(shù)據(jù)等。最好將系統(tǒng)操作的界面圖放入說明書，便于使用者學(xué)習(xí)與操作。③問題解釋：解釋了系統(tǒng)使用中可能出現(xiàn)的問題及解決辦法，如非常規(guī)操作命令、系統(tǒng)恢復(fù)過程及意外情況與開發(fā)單位的聯(lián)系方式等。信息系統(tǒng)運行過程中，用戶還需要記錄運行日志。在發(fā)現(xiàn)需要對系統(tǒng)修正、更改的問題時，應(yīng)將存在的問題、修改的考慮以及修改的影響估計作詳細(xì)的描述，寫成維護修改建議書(或叫維護修改申請書)，提交審批。維護修改建議書也是系統(tǒng)運行維護期間的重要文檔。（8）系統(tǒng)使用與維護手冊21（9）系統(tǒng)評價報告

系統(tǒng)評價報告主要是根據(jù)系統(tǒng)可行性研究報告、系統(tǒng)分析說明書、系統(tǒng)設(shè)計說明書所確定的新系統(tǒng)的目標(biāo)、功能、性能、計劃執(zhí)行情況及新系統(tǒng)實現(xiàn)后的經(jīng)濟效益和社會效益等給予評價。如果該信息系統(tǒng)的開發(fā)已作為立項的科研項目，那么，還要請專家進(jìn)行鑒定。系統(tǒng)評價報告主要包括：①概述。②系統(tǒng)構(gòu)成。③系統(tǒng)達(dá)到設(shè)計目標(biāo)的情況。④系統(tǒng)的可靠性、安全性、保密性、可維護性等狀況。⑤系統(tǒng)的經(jīng)濟效益與社會效益的評價。⑥總結(jié)性評價。

有的項目聘請了相應(yīng)的監(jiān)理方與審計機構(gòu)，那么還需要有相應(yīng)的系統(tǒng)監(jiān)理報告和系統(tǒng)審計報告，這兩種報告的內(nèi)容大體與系統(tǒng)評價報告相同。（9）系統(tǒng)評價報告22（10）系統(tǒng)開發(fā)月報與系統(tǒng)開發(fā)總結(jié)報告信息系統(tǒng)項目的建設(shè)開始以后，各任務(wù)的負(fù)責(zé)人應(yīng)該按月向管理部門提交相應(yīng)的項目進(jìn)展情況報告。報告應(yīng)包括進(jìn)度計劃與實際執(zhí)行情況的比較、階段成果、遇到的問題和解決的辦法以及下個月的打算等。在整個信息系統(tǒng)項目開發(fā)已經(jīng)完成，并且系統(tǒng)正式運行一段時間以后，系統(tǒng)開發(fā)人員應(yīng)與項目實施計劃對照、總結(jié)實際執(zhí)行的情況，如進(jìn)度、成果、資源利用、成本和投入的人力，從而對開發(fā)工作做出評價，總結(jié)出經(jīng)驗和教訓(xùn)，形成系統(tǒng)開發(fā)總結(jié)報告。系統(tǒng)開發(fā)總結(jié)報告包括以下內(nèi)容：①概述：包括信息系統(tǒng)的提出者、開發(fā)者、用戶；系統(tǒng)開發(fā)的主要依據(jù)：系統(tǒng)開發(fā)的目的：系統(tǒng)開發(fā)的可行性分析等。②信息系統(tǒng)項目的完成情況：包括系統(tǒng)構(gòu)成與主要功能；系統(tǒng)性能與技術(shù)指標(biāo)：計劃與實際進(jìn)度對比：費用預(yù)算與實際費用的對比等。③系統(tǒng)評價：系統(tǒng)的主要特點；采用的技術(shù)方法與評價；系統(tǒng)工作效率與質(zhì)量；存在的問題與原因：用戶的評價與反饋意見。④經(jīng)驗與教訓(xùn)：系統(tǒng)開發(fā)過程中的經(jīng)驗與教訓(xùn)：對今后工作的建議：對外發(fā)表的論文。（10）系統(tǒng)開發(fā)月報與系統(tǒng)開發(fā)總結(jié)報告23 總而言之，信息系統(tǒng)的文檔是系統(tǒng)建設(shè)中的重要組成部分，對于系統(tǒng)開發(fā)的成功和系統(tǒng)維護的正常起著保證和支持作用。對各階段產(chǎn)生的文檔要參照國家軟件開發(fā)規(guī)范進(jìn)行填寫并按照統(tǒng)一的格式進(jìn)行編號(本章附錄中詳細(xì)介紹了國家標(biāo)準(zhǔn)《計算機軟件產(chǎn)品開發(fā)文件編制指南》)。文檔的多少和大小、復(fù)雜程度與所開發(fā)的信息系統(tǒng)的大小和復(fù)雜程度成正比。另外，信息系統(tǒng)的文檔還因開發(fā)方法的不同而有所差異。用戶可根據(jù)實際情況確定信息系統(tǒng)開發(fā)的文檔種類和內(nèi)容。文檔要盡可能地簡單明了，便于閱讀，并且盡量使用圖、表進(jìn)行說明。 總而言之，信息系統(tǒng)的文檔是系統(tǒng)建設(shè)中的重要組成部分，對242、系統(tǒng)分析說明書編寫指南系統(tǒng)分析說明書內(nèi)容：引言項目概述實施總計劃2、系統(tǒng)分析說明書編寫指南系統(tǒng)分析說明書內(nèi)容：25引言（1）摘要：摘要說明所建議開發(fā)的系統(tǒng)的名稱、目標(biāo)和功能。（2）背景。

①項目的承擔(dān)者。

②用戶。

③本系統(tǒng)和其他系統(tǒng)或機構(gòu)的關(guān)系和聯(lián)系。（3）參考和引用資料。

①本項目經(jīng)核準(zhǔn)的計劃任務(wù)書或合同及上級機關(guān)的批文。

②屬于本項目的其他已發(fā)表的文件。

③本文件中各處引用的文件資料：列出文件資料的標(biāo)題、編號、發(fā)表日期和制定單位。說明這些文件資料的來源。（４）專門術(shù)語定義：列出本文件所用到的術(shù)語。引言（1）摘要：摘要說明所建議開發(fā)的系統(tǒng)的名稱、目標(biāo)和26項目概述（1）項目的主要工作內(nèi)容。簡要地說明本項目在開發(fā)中須進(jìn)行的各項主要工作。這些工作是建立新系統(tǒng)邏輯模型的必要條件。而邏輯模型是書寫系統(tǒng)說明書的基礎(chǔ)。（2）系統(tǒng)需求說明。新系統(tǒng)是在現(xiàn)行系統(tǒng)的基礎(chǔ)上建立起來的。在新系統(tǒng)設(shè)計工作開展之前，必須對系統(tǒng)調(diào)查清楚，掌握現(xiàn)行系統(tǒng)的真實情況，了解用戶的新要求和問題所在。

①現(xiàn)行系統(tǒng)的現(xiàn)狀調(diào)查說明：列出現(xiàn)行系統(tǒng)的目標(biāo)、主要功能、用戶要求等，并簡要指出問題所在。

②業(yè)務(wù)流程說明：簡要說明現(xiàn)行系統(tǒng)現(xiàn)場工作流程和事務(wù)流程概況。若需要反映這些業(yè)務(wù)流程的業(yè)務(wù)流程圖，可以另附。項目概述（1）項目的主要工作內(nèi)容。27（3）系統(tǒng)功能說明。

在現(xiàn)行系統(tǒng)現(xiàn)狀調(diào)查的基礎(chǔ)上，進(jìn)一步透過具體工作，分析組織內(nèi)的信息、數(shù)據(jù)流動的路徑和過程，真正弄清用戶要解決什么問題，明確系統(tǒng)的功能要求。數(shù)據(jù)流程圖是系統(tǒng)需求的高度概括，是調(diào)查研究的重要產(chǎn)物。它源于現(xiàn)行系統(tǒng)，又高于現(xiàn)行系統(tǒng)。這里主要通過數(shù)據(jù)流程圖概況說明系統(tǒng)的功能要求。

①新系統(tǒng)的目標(biāo)：從新系統(tǒng)數(shù)據(jù)流程圖的分析中，說明新系統(tǒng)有哪些目標(biāo)。

②新系統(tǒng)的功能要求：列出系統(tǒng)的主要功能。

③驗收：簡單說明驗收要求。（3）系統(tǒng)功能說明。28（4）系統(tǒng)的數(shù)據(jù)要求說明。

從數(shù)據(jù)流程圖和數(shù)據(jù)字典分析邏輯數(shù)據(jù)結(jié)構(gòu)，標(biāo)識每個數(shù)據(jù)結(jié)構(gòu)中的每個數(shù)據(jù)項、記錄和文件的長度以及它們之間的關(guān)系。

①系統(tǒng)的數(shù)據(jù)要求：這里的數(shù)據(jù)是指靜態(tài)數(shù)據(jù)，即在運行過程中主要作為參考的數(shù)據(jù)，它們在很長一段時間內(nèi)不會變化，一般不隨運行而改變。

A．?dāng)?shù)據(jù)項定義：說明數(shù)據(jù)項定義中出現(xiàn)的例外情況，列出作為控制或參考的主要數(shù)據(jù)項。

B．容量：本系統(tǒng)所有數(shù)據(jù)項的總長度。

C．用戶。

D．驗收：指出驗收情況。

②系統(tǒng)的數(shù)據(jù)要求的粗略估計：粗略估算系統(tǒng)在運行過程中動態(tài)數(shù)據(jù)的內(nèi)容。（4）系統(tǒng)的數(shù)據(jù)要求說明。29實施總計劃（1）工作任務(wù)的分解。對于項目開發(fā)中應(yīng)完成的各項工作，按系統(tǒng)功能(或子系統(tǒng))劃分，指定專人(或小組)分工完成，指明每項任務(wù)的負(fù)責(zé)人。（2）進(jìn)度。

給出每項工作任務(wù)的預(yù)定開始日期和完成日期，規(guī)定各項工作任務(wù)完成的先后順序以及每項工作任務(wù)完成的界面。（3）預(yù)算。

逐項列出本開發(fā)項目所需要的勞務(wù)(包括工作量/人)以及經(jīng)費的預(yù)算（包括辦公費、差旅費、資料費等）。實施總計劃（1）工作任務(wù)的分解。303、系統(tǒng)設(shè)計說明書內(nèi)容指南

引言（1）摘要（2）背景（3）工作條件/限制（4）參考和引用資料（5）專門術(shù)語定義

系統(tǒng)總體技術(shù)方案（1）模塊設(shè)計。（2）代碼設(shè)計。（3）輸入設(shè)計。（4）輸出設(shè)計。（5）數(shù)據(jù)庫設(shè)計說明。（6）模型庫及方法庫設(shè)計。（7）網(wǎng)絡(luò)設(shè)計：系統(tǒng)的網(wǎng)絡(luò)結(jié)構(gòu)，功能的設(shè)計。（8）安全保密設(shè)計。（9）實施方案說明書。3、系統(tǒng)設(shè)計說明書內(nèi)容指南引言31（1）摘要：摘要說明所設(shè)計的系統(tǒng)的名稱、目標(biāo)和功能。（2）背景。

①項目的承擔(dān)者。

②用戶。

③本項目和其他系統(tǒng)或機構(gòu)的關(guān)系和聯(lián)系。（3）工作條件/限制：說明本項目開發(fā)中所具備的工作條件和受到的限制。

①硬件/軟件/運行環(huán)境方面的限制。

②保密和安全的限制。

③有關(guān)部門的業(yè)務(wù)人員提供確切的數(shù)據(jù)及其定義。

④有關(guān)系統(tǒng)軟件文本。

⑤網(wǎng)絡(luò)協(xié)議標(biāo)準(zhǔn)文本。

⑥國家安全保密條例。（4）參考和引用資料

①本項目的已核準(zhǔn)的計劃任務(wù)書或合同和上級機關(guān)的批文。

②屬于本項目的其他已發(fā)表的文件。

③本文件中引用的文件資料：列出文件資料的標(biāo)題、編號、發(fā)表日期和制定單位。說明這些文件資料的來源。（5）專門術(shù)語定義：列出本文件所用到的術(shù)語。引言（1）摘要：摘要說明所設(shè)計的系統(tǒng)的名稱、目標(biāo)和功能。32系統(tǒng)總體設(shè)計方案（1）模塊設(shè)計。模塊設(shè)計階段中，在系統(tǒng)內(nèi)部劃分成各個基礎(chǔ)部分——模塊結(jié)構(gòu)，確定系統(tǒng)的總體結(jié)構(gòu)。總體結(jié)構(gòu)與各個分層模塊結(jié)構(gòu)的關(guān)系是程序?qū)嵤┑闹匾罁?jù)。模塊結(jié)構(gòu)采用模塊結(jié)構(gòu)圖來表示。模塊結(jié)構(gòu)是采用HIPO圖(即分層加輸入一處理一輸出圖)形式繪制而成的框圖。

①名稱：列出系統(tǒng)中各主要功能的結(jié)構(gòu)圖名稱和它們之間的關(guān)系。

②功能：用文字簡單說明主要模塊結(jié)構(gòu)圖應(yīng)具有的功能。

③功能說明：說明是用偽碼形式還是用結(jié)構(gòu)英語形式，或者其他自然語言形式描述模塊結(jié)構(gòu)圖的。

④評價

⑤驗收：指設(shè)計人員驗收的決定和處理情況。系統(tǒng)總體設(shè)計方案（1）模塊設(shè)計。33（2）代碼設(shè)計。代碼設(shè)計是信息系統(tǒng)所必需的前提條件，是不可缺少的重要的內(nèi)容。它是進(jìn)行信息分類、校對、總計和檢查的關(guān)鍵，它也用于指定數(shù)據(jù)的處理方法，區(qū)別數(shù)據(jù)類型，并指定計算機處理的內(nèi)容。

①代碼的方式和種類：簡單說明代碼的方式和種類。

②功能：從編碼的原則要求(如單義性、可讀性等)去簡單說明代碼所體現(xiàn)的功能。

③評價：從識別信息、信息標(biāo)準(zhǔn)化、節(jié)省存儲單元、提高運算速度、節(jié)省計算機的處理費用以及代碼的特性進(jìn)行評價。

④驗收。系統(tǒng)總體設(shè)計方案（2）代碼設(shè)計。系統(tǒng)總體設(shè)計方案34（3）輸入設(shè)計。

輸入設(shè)計擔(dān)負(fù)著將系統(tǒng)外的數(shù)據(jù)以一定的格式送入計算機的任務(wù)，它直接影響到人工系統(tǒng)和機器系統(tǒng)的工作質(zhì)量。輸入設(shè)計的基點是確保向信息系統(tǒng)提供正確的信息。輸入必須有必要的介質(zhì)和設(shè)備。

①輸入項目：說明對本系統(tǒng)的主要輸入項目。

②輸入的承擔(dān)者：說明對數(shù)據(jù)輸入工作的承擔(dān)者的安排，并指出操作人員、維護人員的教育水平和技術(shù)專長。如果輸入數(shù)據(jù)同某一接口軟件有關(guān)，應(yīng)說明該接口軟件的來源。

③主要功能要求：從滿足正確、迅速、簡單、經(jīng)濟、方便使用者方面的要求去說明。

④輸入要求：簡單說明各主要輸入數(shù)據(jù)類型和來源及所用的設(shè)備、介質(zhì)、格式、數(shù)值、范圍、精度等。

⑤輸入校驗：簡述所用的數(shù)據(jù)校驗法和效果。

⑥評價。

⑦驗收。

系統(tǒng)總體設(shè)計方案（3）輸入設(shè)計。系統(tǒng)總體設(shè)計方案35（4）輸出設(shè)計。輸出的含義是把由計算機對輸入的原始數(shù)據(jù)進(jìn)行處理加工的結(jié)果按一定的格式提供給用戶。輸出不僅有一定的格式要求，而且還必須有必要的介質(zhì)和設(shè)備。

①輸出項目：說明對本系統(tǒng)的主要輸出項目。

②輸出接受者：說明輸出的主要項目的數(shù)據(jù)的接受者。

③主要功能。

④輸出要求：說明輸出數(shù)據(jù)類型及所用的設(shè)備介質(zhì)、格式、數(shù)值范圍、精度等。

⑤評價。

⑥驗收。系統(tǒng)總體設(shè)計方案（4）輸出設(shè)計。系統(tǒng)總體設(shè)計方案36（5）數(shù)據(jù)庫設(shè)計說明。數(shù)據(jù)庫設(shè)計是指數(shù)據(jù)庫應(yīng)用系統(tǒng)的設(shè)計。編制數(shù)據(jù)庫設(shè)計說明書的目的是對設(shè)計中的數(shù)據(jù)結(jié)構(gòu)的所有標(biāo)識、邏輯結(jié)構(gòu)和物理結(jié)構(gòu)做出其體的設(shè)計規(guī)定。編寫提綱和內(nèi)容要求如下。

①概述。

A．目標(biāo)：說明開發(fā)的意圖、應(yīng)用目標(biāo)、作用范圍以及有關(guān)數(shù)據(jù)庫開發(fā)的背景材料。

B．主要功能：簡要說明數(shù)據(jù)庫系統(tǒng)的主要功能。

C．用戶的安排：指最終用戶。說明操作人員、數(shù)據(jù)管理人員、維護人員的水平。

②需求規(guī)定。

A．精度：簡述對數(shù)據(jù)精度的要求。B．有效性：說明對數(shù)據(jù)庫存取數(shù)據(jù)的有效性的要求。

C．時間要求：如響應(yīng)時間、數(shù)據(jù)的轉(zhuǎn)換和傳送時間等。

D．其他專門要求。（5）數(shù)據(jù)庫設(shè)計說明。37

③運行環(huán)境要求。

A．設(shè)備：簡述運行數(shù)據(jù)庫系統(tǒng)的硬設(shè)備及其專門功能。

B．支撐軟件：列出支撐軟件并說明測試用的軟件。

C．安全保密：說明在安全保密方面的全部要求。

D．其他要求。

④設(shè)計考慮。

A．邏輯結(jié)構(gòu)設(shè)計：簡要說明本系統(tǒng)(或子系統(tǒng))內(nèi)所使用的數(shù)據(jù)結(jié)構(gòu)中，有關(guān)數(shù)據(jù)項、記錄、文件的標(biāo)識、定義、長度及它們之間存在的相互關(guān)系。

B．物理結(jié)構(gòu)設(shè)計：簡要說明本系統(tǒng)內(nèi)所使用的數(shù)據(jù)結(jié)構(gòu)中有關(guān)數(shù)據(jù)庫的存儲要求、訪問方法、存取單位、存取的物理關(guān)系(索引、設(shè)備、存儲區(qū)域)、設(shè)計考慮和保密處理。

⑤評價：簡要說明對時間、空間效率、維護代價和各種用戶要求進(jìn)行權(quán)衡所產(chǎn)生的方案性能情況。

⑥驗收。③運行環(huán)境要求。38（6）模型庫及方法庫設(shè)計。（7）網(wǎng)絡(luò)設(shè)計：系統(tǒng)的網(wǎng)絡(luò)結(jié)構(gòu)，功能的設(shè)計。（8）安全保密設(shè)計。

（9）實施方案說明書。系統(tǒng)總體結(jié)構(gòu)設(shè)計完成以后就要確定系統(tǒng)實施方案，書寫實施方案說明書。信息系統(tǒng)的研制工作就從系統(tǒng)設(shè)計階段轉(zhuǎn)入實施階段。實施方案說明書就作為系統(tǒng)實施階段的依據(jù)和出發(fā)點。（6）模型庫及方法庫設(shè)計。39①實施方案說明。

A．項目的說明：指對系統(tǒng)名稱、子系統(tǒng)名稱、程序名稱、程序語言、使用的設(shè)備等逐項說明。

B．?dāng)?shù)據(jù)項目的說明：指對數(shù)據(jù)長度、文件名稱和形式編號、構(gòu)成記錄的各項目名稱和內(nèi)容等逐項說明。

C．處理內(nèi)容說明：指對進(jìn)行程序設(shè)計的處理內(nèi)容進(jìn)行詳細(xì)說明。③實施方案的審批。

A．參與審議人員：除用戶、系統(tǒng)研制人員、程序員、操作員等以外，還包括邀請的專家、管理人員等。

B．審批的實施方案：說明經(jīng)審批的實施方案的概況和審批人員名單。

②實施的總計劃。

A．工作任務(wù)的分解：對項目開發(fā)中須完成的各項工作。包括文件編制、審批、打印、用戶培訓(xùn)工作、使用設(shè)備的安排工作等，按層次進(jìn)行分解，指明每項任務(wù)的要求。

B．進(jìn)度：給出每項工作任務(wù)(包括文件編制)的預(yù)定開始日期和完成日期，規(guī)定各項工作任務(wù)完成的先后順序以及每項工作任務(wù)完成的標(biāo)志。

C．預(yù)算：逐項列出本開發(fā)項目所需要的勞務(wù)(包括辦公費、差旅費、機時費、資料費、通信設(shè)備和專用設(shè)備的租金。①實施方案說明。②實施的總計劃。40三、信息系統(tǒng)文檔的編制與管理

影響文檔質(zhì)量的原因有上一節(jié)講到的是否規(guī)范的問題，有認(rèn)識上的問題，編寫技術(shù)上的問題，評價標(biāo)準(zhǔn)的問題。而上述問題的解決都離不開對信息系統(tǒng)文檔的管理。因而，這一節(jié)首先介紹信息系統(tǒng)文檔編制的要求與方法，然后介紹信息系統(tǒng)文檔的管理問題。本節(jié)內(nèi)容:l、信息系統(tǒng)文檔編制的要求與方法2、信息系統(tǒng)文檔的管理三、信息系統(tǒng)文檔的編制與管理影響文檔質(zhì)量的原因有上一41

為了使信息系統(tǒng)的文檔能起到前面所提到的多種溝通作用，使它有助于程序員編制程序，有助于管理人員監(jiān)督和管理軟件開發(fā)，有助于用戶了解信息系統(tǒng)的工作方式和應(yīng)做的操作，有助于維護人員進(jìn)行有效的修改和擴充，就必然要求文檔的編制要保證一定的質(zhì)量。質(zhì)量差的文檔不僅使讀者難于理解，給使用者造成許多不便，而且會削弱對信息系統(tǒng)的管理(管理人員難以確認(rèn)和評價開發(fā)工作的進(jìn)展)，增加信息系統(tǒng)的開發(fā)成本（一些工作可能被迫返工），甚至造成更加有害的后果（如誤操作等）。１、信息系統(tǒng)文檔編制的要求與方法為了使信息系統(tǒng)的文檔能起到前面所提到的多種溝通作用，42

造成信息系統(tǒng)文檔質(zhì)量不高的原因主要有四個：

（1）認(rèn)識上的問題：不重視文檔編寫工作。

（2）規(guī)范上的問題：不按各類文檔的規(guī)范寫作，文檔的編寫具有很大的隨意性。

（3）技術(shù)上的問題：缺乏編寫文檔的實踐經(jīng)驗，對文檔編寫工作的安排不恰當(dāng)。

（4）評價上的問題：缺乏評價文檔質(zhì)量的標(biāo)準(zhǔn)。造成信息系統(tǒng)文檔質(zhì)量不高的原因主要有四個：43首先是認(rèn)識上的問題。信息系統(tǒng)建設(shè)過程在很火程度上是應(yīng)用軟件的開發(fā)過程。就軟件的兩大部分——程序和文檔而言，程序相對來說是“硬件”，是必須最終完成的。作為開發(fā)者往往認(rèn)為只要最終程序正確，能夠滿足系統(tǒng)需求就達(dá)到了系統(tǒng)要求。而文檔是“軟件”，有一些是必須完成，而有些則無嚴(yán)格要求，并且也可以事后補充。因而，為了追求開發(fā)進(jìn)度，一些文檔資料常常被忽略。另外，文檔經(jīng)常是給別人看的，文檔的作用很多是在事后才能體現(xiàn)出來的，使得系統(tǒng)開發(fā)人員缺乏書寫文檔的動力和自覺性。于是在程序工作完成以后，不得不應(yīng)付一下，把要求提供的文檔趕寫出來。這樣的做法不可能得到高質(zhì)量的文檔。首先是認(rèn)識上的問題。信息系統(tǒng)建設(shè)過程在很火程度上是應(yīng)用44

實際上，要得到真正高質(zhì)量的文檔并不容易。除去應(yīng)在認(rèn)識上對文檔工作給予足夠的重視外，還要將上節(jié)以及附錄作為撰寫文檔時的參考，從而規(guī)范文檔的寫作。高質(zhì)量的文檔一般都需要經(jīng)過編寫初稿、聽取意見進(jìn)行修改、甚至要經(jīng)過重新改寫的過程。

高質(zhì)量的文檔應(yīng)當(dāng)體現(xiàn)在以下一些方面：（1）針對性（2）精確性與統(tǒng)一性

（3）清晰性（4）完整性

（5）靈活性（6）可追溯性

（7）易檢索性實際上，要得到真正高質(zhì)量的文檔并不容易。除去應(yīng)在認(rèn)識上45

為了得到高質(zhì)量的文檔，除認(rèn)識上予以重視，采用一定的格式外，文檔的編寫技術(shù)非常重要。

編寫原則

（1）立足于讀者。（2）立足于實際需要。（3）文字準(zhǔn)確、簡單明了。

編排原則

（1）所有文檔都應(yīng)該編排得便于迅速查到所需要的內(nèi)容。（2）采用由一般到具體的層次結(jié)構(gòu)法。（3）可能的情況下還可以采用詞匯之間的互相鏈接。（4）在可能的情況下，應(yīng)使圖表放在它所解釋的文字附近，以便在閱讀正文的同時也能看劍圖表。（5）適當(dāng)使川不同的字體和版式，以增加一段正文的明晰度。為了得到高質(zhì)量的文檔，除認(rèn)識上予以重視，采用一定的格式外46

裝訂原則（1）如果文檔需要修改，宜采用活頁裝訂，以便可以隨時去掉某頁面。發(fā)行時應(yīng)采用使各頁面易于分開的裝訂方法。（2）頁面編號中間由橫線連接的三組數(shù)字組成：第一組數(shù)字指卷次，第二組數(shù)字指卷內(nèi)的章次，第二組數(shù)字指該章中的頁次。（3）在修改文檔頁碼時，要加頁碼的第一部分與前一頁的頁碼相同，第二部分用一個小數(shù)點后跟頁號組成。例如要往4—29頁和4—30頁之間插入一頁，那么其編號應(yīng)為4—29.1。

詞匯與索引（1）技術(shù)術(shù)語的使用應(yīng)該適當(dāng)控制。（2）使用技術(shù)術(shù)語前，要準(zhǔn)確定義每個術(shù)語，使用也要恰如其分。（3）不同地方對同一內(nèi)容應(yīng)采用同一術(shù)語。（4）避免濫用術(shù)語。（5）每種用戶文檔均應(yīng)有一個詞匯表和索引。索引可以與詞匯表結(jié)合起來。（6）詞匯表與索引的編排必須重視如何讓讀者快速查到該功能。裝訂原則詞匯與索引47２、信息系統(tǒng)文檔的管理信息系統(tǒng)的文檔與其他類型的文檔一樣，也具有它自身的生命周期。生命周期的劃分：創(chuàng)建期、處理期、存儲期、使用期、銷毀期。每種文檔都處于生命周期中的某一時期。當(dāng)然周期的劃分也不是絕對的，各周期有時是不能截然分開的。要強調(diào)的是，由于在整個信息系統(tǒng)的生存期中，各種文檔作為半成品或是最終成品，會不斷地生成、修改或補充。同時，這些信息系統(tǒng)的文檔還會成為新一代系統(tǒng)研制時的參考和依據(jù)。因而，信息系統(tǒng)文檔的生命周期普遍要比信息系統(tǒng)的生命周期長。也就是說，絕大多數(shù)信息系統(tǒng)的文檔要在相應(yīng)的信息系統(tǒng)淘汰3至5年后才能銷毀。２、信息系統(tǒng)文檔的管理信息系統(tǒng)的文檔與其他類型的文檔一樣48

為了最終得到高質(zhì)量的信息系統(tǒng)文檔，達(dá)到上節(jié)提出的質(zhì)量要求，在信息系統(tǒng)的建設(shè)過程中必須加強對文檔的管理。文檔管理應(yīng)從以下幾個方面著手進(jìn)行。（1）文檔管理的制度化（2）文檔要標(biāo)準(zhǔn)化、規(guī)范化（3）文檔管理的人員保證（4）維護文檔的一致性

（5）維持文檔的可追蹤性為了最終得到高質(zhì)量的信息系統(tǒng)文檔，達(dá)到上節(jié)提出的質(zhì)量要求49（1）文檔管理的制度化

必須形成一整套的文檔管理制度，其內(nèi)容可以包含文檔的標(biāo)準(zhǔn)、修改文檔和出版文檔的條件、開發(fā)人員在系統(tǒng)建設(shè)不同時期就其文檔建立工作應(yīng)承擔(dān)的責(zé)任和任務(wù)。根據(jù)這一套完善的制度來最終協(xié)調(diào)、控制系統(tǒng)開發(fā)工作，并以此對每一個開發(fā)成員的工作進(jìn)行評價。（2）文檔要標(biāo)準(zhǔn)化、規(guī)范化在系統(tǒng)開發(fā)前必須首先選擇或制定文檔標(biāo)準(zhǔn)。在統(tǒng)一標(biāo)準(zhǔn)制約下，開發(fā)人員負(fù)責(zé)建立所承擔(dān)任務(wù)的文檔資料。對于已有參考格式和內(nèi)容的文檔。如上節(jié)中提到的系統(tǒng)分析說明書，應(yīng)盡量按相應(yīng)的規(guī)范撰寫文檔。對于沒有參考格式的文檔。如需變更申請書，應(yīng)該在項目組內(nèi)部出臺相應(yīng)的規(guī)范和格式。表8-1是某個項目組制定的內(nèi)部使用的需求變更申請書格式。（1）文檔管理的制度化（2）文檔要標(biāo)準(zhǔn)化、規(guī)范化50信息系統(tǒng)的管理課件51（3）文檔管理的人員保證

項目小組應(yīng)設(shè)文檔組或至少一位文檔保管人員，負(fù)責(zé)集中保管本項目已有文檔的兩套主文本。兩套文本內(nèi)容應(yīng)完全一致。其中的一套可按一定手續(xù)，辦理借閱。（４）維持文檔的可追蹤性

由于信息系統(tǒng)開發(fā)的動態(tài)性，系統(tǒng)的某種修改是否最終有效，要經(jīng)過一段時間的檢驗，因此文檔要分版本來實現(xiàn)。而各版本的出版時機及要求也要有相應(yīng)的制度。（3）文檔管理的人員保證（４）維持文檔的可追52（4）維護文檔的一致性

信息系統(tǒng)開發(fā)建設(shè)過程是一個不斷變化的動態(tài)過程，一旦需要對某一文檔進(jìn)行修改時，要及時、準(zhǔn)確地修改與之相關(guān)聯(lián)的文檔：否則將會引起系統(tǒng)開發(fā)工作的混亂。而這一過程又必須有相應(yīng)的制度來保證。

①項目成員可根據(jù)工作需要在自己手中保存一些個人文檔。②項目開發(fā)結(jié)束時，文檔管理人員應(yīng)收回開發(fā)人員的個人文檔。發(fā)現(xiàn)個人文檔與主文有差別時，應(yīng)立即著手解決。這常常是未及時修訂主文本造成的。③往新文檔取代了舊文檔時，文檔管理人員應(yīng)及時注銷舊文檔。④主文本的修改必須特別謹(jǐn)慎。修改以前要充分估計修改可能帶來的影響，并且要按照：提議、評議、審核、批準(zhǔn)和實施等步驟加以嚴(yán)格控制。（4）維護文檔的一致性

信息系統(tǒng)開發(fā)建設(shè)過程是一53

以上是系統(tǒng)建設(shè)過程中文檔管理需注意的問題，至于運行過程中的文檔管理，與開發(fā)過程中的文檔管理的方法大同小異，這里就不再贅述。撰寫文檔的目的是為了指導(dǎo)信息系統(tǒng)的開發(fā)、維護和幫助用戶的使用。前面講到的都是如何提高文檔本身的質(zhì)量。下面要講到的是文檔的使用者如何快速地從文檔中得到所需的內(nèi)容。所以文檔管理的另一個重要問題是：如何在需要的時候，將它們迅速、準(zhǔn)確、全面地檢索出來。以上是系統(tǒng)建設(shè)過程中文檔管理需注意的問題，至于運行過程中54

信息系統(tǒng)的文檔大部分都是在計算機上完成的，基本具備電子文檔的性質(zhì)。但是要將這些電子文檔實現(xiàn)快速檢索就不僅僅是建幾個子目錄、建幾層子目錄的問題了。這涉及到與待建項目相對應(yīng)的文檔管理信息系統(tǒng)的建立。

應(yīng)該說明的是，這里對信息系統(tǒng)文檔的檢索管理經(jīng)常涉及的對象并不是檔案全文，而是對檔案原文進(jìn)行加工、處理后得到的檔案二次文獻(xiàn)信息，即其中具有特定標(biāo)識意義的部分，如文檔名、責(zé)任者、關(guān)鍵詞等項目。當(dāng)然記錄中的項目可以根據(jù)實際情況增加或減少。信息系統(tǒng)的文檔大部分都是在計算機上完成的，基本具備電子文55

這樣，通過適當(dāng)?shù)臄?shù)據(jù)結(jié)構(gòu)，使文檔按內(nèi)容分類，建立相應(yīng)的文檔管理信息系統(tǒng)就能做到對信息系統(tǒng)的文檔作快速的檢索了。在文檔管理信息系統(tǒng)中，還可設(shè)置一些檢索的約束。我們可以把它們視作兩個條件：

前置條件和后置條件。前置條件意味著在使用該文檔之前要首先檢驗的條件。例如，閱讀文檔的用戶級別：只允許項目經(jīng)理查閱的文檔，不是經(jīng)理就不能訪問該文檔。后置條件意味著將該文檔歸檔之前必須滿足的條件，比如必須填寫的文檔項，如負(fù)責(zé)人的簽字。這樣，通過適當(dāng)?shù)臄?shù)據(jù)結(jié)構(gòu)，使文檔按內(nèi)容分類，建立相應(yīng)的56從上述文檔管理的內(nèi)容可以看出，如果采用手工方式建立這些文檔資料，很難適應(yīng)這種不斷修改、不斷完善的客觀需求。因此，信息系統(tǒng)文檔的建立應(yīng)當(dāng)充分利用現(xiàn)有的輔助開發(fā)工具及一些字處理軟件等。目前已經(jīng)有相應(yīng)的CASE工具能夠自動生成信息系統(tǒng)的某些文檔。有些工具還能輔助進(jìn)行文檔的檢索管理。這些工具的使用能夠有利于提高信息系統(tǒng)文檔的質(zhì)量，從而最終提高信息系統(tǒng)的開發(fā)質(zhì)量和運行質(zhì)量。從上述文檔管理的內(nèi)容可以看出，如果采用手工方式建立這些文57l、詳細(xì)說明信息系統(tǒng)文檔的作用。2、信息系統(tǒng)的文檔有哪幾種分類方法，各有哪些類型?3、討論不同的開發(fā)方法在編寫文檔時的區(qū)別。4、你認(rèn)為對于小型的信息系統(tǒng)應(yīng)該撰寫哪些文檔?5、文檔在信息系統(tǒng)開發(fā)中沒有受到足夠重視的原因是什么?你有什么好辦法激勵開發(fā)人員寫好文檔?6、高質(zhì)量的文檔應(yīng)該包含哪些內(nèi)容?如何編寫高質(zhì)量的文檔?7、信息系統(tǒng)文檔的管理應(yīng)從哪幾方面著手?8、請你設(shè)計信息系統(tǒng)文檔檢索信息系統(tǒng)的功能。9、有興趣的同學(xué)可以試著開發(fā)一個文檔管理信息系統(tǒng)。思考題l、詳細(xì)說明信息系統(tǒng)文檔的作用。思考題58

信息系統(tǒng)的文檔，是系統(tǒng)建設(shè)過程的“痕跡”，是系統(tǒng)維護人員的指南，是開發(fā)人員與用戶交流的工具。規(guī)范的文檔意味著系統(tǒng)是按照工程化開發(fā)的，意味著信息系統(tǒng)的質(zhì)量有了形式上的保障。文檔的欠缺、文檔的隨意性和文檔的不規(guī)范，極有可能導(dǎo)致原來的開發(fā)人員流動以后，系統(tǒng)不可以維護、不可以升級，變成一個沒有擴展性、沒有生命力的系統(tǒng)。所以，為了建立一個良好的信息系統(tǒng)，不僅要充分利用各種現(xiàn)代化信息技術(shù)和正確的系統(tǒng)開發(fā)方法，同時還要做好文檔的管理工作。

本節(jié)主要討論的內(nèi)容：一、信息系統(tǒng)文檔的作用與類型二、信息系統(tǒng)各類文檔的內(nèi)容三、信息系統(tǒng)文檔的編制與管理

第八章、信息系統(tǒng)的文檔管理信息系統(tǒng)的文檔，是系統(tǒng)建設(shè)過程的“痕跡”，是系統(tǒng)維護人員59一、信息系統(tǒng)文檔的作用與類型

在軟件工程的學(xué)科領(lǐng)域里，文檔和程序加在一起被合稱為軟件。文檔與程序的區(qū)別在于前者是人可讀的，后者主要是機器用來執(zhí)行的。如果將源程序加上注釋，也可稱為文檔的一部分。本節(jié)主要介紹：l、信息系統(tǒng)文檔的作用2、信息系統(tǒng)文檔的類型

一、信息系統(tǒng)文檔的作用與類型 在軟件工程的學(xué)科領(lǐng)域里，60l、信息系統(tǒng)文檔的作用

這里指的信息系統(tǒng)的文檔，不但包括應(yīng)用軟件開發(fā)過程中產(chǎn)生的文檔，還包括硬件采購和網(wǎng)絡(luò)設(shè)計中形成的文檔；不但包括上述有一定格式要求的規(guī)范文檔，也包括系統(tǒng)建設(shè)過程中的各種來往文件、會議紀(jì)要、會計單據(jù)等資料形成的不規(guī)范文檔，后者是建設(shè)各方談判甚至索賠的重要依據(jù)。顯然，文檔的含義在信息系統(tǒng)學(xué)科領(lǐng)域里比軟件工程學(xué)科寬泛。

所以文檔是軟件的一部分，更是信息系統(tǒng)的一部分。沒有文檔的軟件，不稱其為合格的軟件；沒有文檔的信息系統(tǒng)，不稱其為完整的信息系統(tǒng)。l、信息系統(tǒng)文檔的作用這里指的信息系統(tǒng)的文檔，不但包括應(yīng)61

文檔在系統(tǒng)開發(fā)人員、項目管理人員、系統(tǒng)維護人員、系統(tǒng)評價人員以及用戶之間的多種橋梁作用可從圖

8-1中看出。圖8-1中列出了文檔在信息系統(tǒng)建設(shè)和運行過程中的七種典型溝通作用：文檔用戶開發(fā)人員前期開發(fā)人員開發(fā)人員開發(fā)人員開發(fā)人員用戶系統(tǒng)開發(fā)人員項目管理人員后期開發(fā)人員測試人員用戶維護人員維護人員圖8-1信息系統(tǒng)文檔的溝通作用圖文檔在系統(tǒng)開發(fā)人員、項目管理人員、系統(tǒng)維護人員、系統(tǒng)評價62（1）用戶與系統(tǒng)分析人員在系統(tǒng)規(guī)劃和系統(tǒng)分析階段通過文檔進(jìn)行溝通。（2）人員與項目管理人員通過文檔在項目期內(nèi)進(jìn)行溝通。（3）前期開發(fā)人員與后期開發(fā)人員通過書面文檔進(jìn)行溝通。（4）系統(tǒng)測試人員與系統(tǒng)開發(fā)人員通過文檔進(jìn)行溝通。（5）系統(tǒng)開發(fā)人員與用戶在系統(tǒng)運行期間進(jìn)行溝通。（6）系統(tǒng)開發(fā)人員與系統(tǒng)維護人員通過文檔進(jìn)行溝通。（7）用戶與維護人員在運行維護期間進(jìn)行溝通。

上述七個方面是文檔在溝通方面的主要作用，其實，文檔還可以作為監(jiān)理和審計的對象，作為開發(fā)其他信息系統(tǒng)的參照。（1）用戶與系統(tǒng)分析人員在系統(tǒng)規(guī)劃和系統(tǒng)分析階段通過文檔進(jìn)行63

如果發(fā)生合同糾紛，文檔還能體現(xiàn)出證據(jù)的作用。因為每份文檔都是項目建設(shè)中有關(guān)成員的一種書面承諾。絕大多數(shù)文檔都是需要簽名的。而簽名就表示對自己所簽署的那部分文檔內(nèi)容的認(rèn)可和承擔(dān)責(zé)任。特別是用戶提出的需求變更申請書必須妥善保管，這些文件在發(fā)生糾紛時往往能成為保護自己甚至索賠的重要依據(jù)。顯然，文檔的編制在信息系統(tǒng)的開發(fā)工作中占有突出的地位和相當(dāng)?shù)墓ぷ髁?。高效率、高質(zhì)量地寫作、分發(fā)、管理和維護文檔對于充分發(fā)揮信息系統(tǒng)的效益有著重要意義。如果發(fā)生合同糾紛，文檔還能體現(xiàn)出證據(jù)的作用。因為每份文檔642、信息系統(tǒng)文檔的類型

信息系統(tǒng)的文檔有許多種分類方法：（1）按照產(chǎn)生頻率分為一次性文檔和非一次性文檔。前者如系統(tǒng)分析說明書、系統(tǒng)設(shè)計說明書等，后者如開發(fā)過程中用戶提交的需求變更申請書。非一次性文檔還可以分為頻率固定文檔和頻率不固定文檔，頻率固定文檔有項目組月度開發(fā)報告、信息系統(tǒng)運行日志、運行月報等，頻率不固定文檔有會計單據(jù)、需求變更申請書、維護修改建議書等。 一次性文檔和頻率固定的文檔一般都有較固定的內(nèi)容和格式，而頻率不固定的文檔由于發(fā)生的隨機性，導(dǎo)致文檔記錄人員在撰寫文檔時的隨意性。為了管理好這些頻率不固定的文檔，需要對這些文檔予以編號，并盡可能地統(tǒng)一格式，以便做到規(guī)范管理。2、信息系統(tǒng)文檔的類型信息系統(tǒng)的文檔有許多種分類方法：65（2）按照信息系統(tǒng)生命周期的階段不同，可以劃分為：系統(tǒng)規(guī)劃階段文檔，如系統(tǒng)可行性研究報告、項目開發(fā)計劃書等；系統(tǒng)分析階段的文檔，如系統(tǒng)分析說明書等；系統(tǒng)設(shè)計階段的文檔，如系統(tǒng)設(shè)計說明書、需求變更申請書等；系統(tǒng)實現(xiàn)階段的文檔，如程序設(shè)計報告、系統(tǒng)測試報告、開發(fā)總結(jié)報告等；系統(tǒng)運行與維護階段的文檔，如用戶手冊、操作手冊與維護修改建議書等。本書的附錄——國家標(biāo)準(zhǔn)《計算機軟件產(chǎn)品開發(fā)文件編制指南》基本上是按照軟件的生命周期進(jìn)行講解的，可以作為信息系統(tǒng)文檔的參照。（2）按照信息系統(tǒng)生命周期的階段不同，可以劃分為：系統(tǒng)規(guī)劃階66（3）按照文檔不同的服務(wù)目的，可以將信息系統(tǒng)的文檔分為三類：用戶文檔、開發(fā)文檔與管理文檔。用戶文檔主要是為用戶服務(wù)的，開發(fā)文檔主要是為開發(fā)人員服務(wù)的，管理文檔主要是為項目管理人員服務(wù)的。上述三種文檔的內(nèi)容參見圖8-2。當(dāng)然，圖中的分類不是絕對的，比如項目開發(fā)計劃對于開發(fā)人員來講很重要；測試計劃和測試報告對于管理人員來講也很重要。這里要強調(diào)項目管理文檔的重要性。項目管理文檔是對項目計劃、費用和問題進(jìn)行監(jiān)督的管理手段和項目建設(shè)過程進(jìn)行記錄的工具。這能使各級管理部門對項目的進(jìn)展保持預(yù)見性，以便能及時發(fā)現(xiàn)和處理系統(tǒng)開發(fā)及維護過程中出現(xiàn)的問題。（3）按照文檔不同的服務(wù)目的，可以將信息系統(tǒng)的文檔分為三類：67信息系統(tǒng)的文檔用戶文檔開發(fā)文檔管理文檔用戶手冊操作手冊運行日志/月報維護修改建議書系統(tǒng)分析說明系統(tǒng)設(shè)計說明程序設(shè)計說明測試計劃測試報告可行性研究報告項目開發(fā)計劃需求變更申請書開發(fā)進(jìn)度月報開發(fā)總結(jié)報告圖8-2按照服務(wù)目的不同劃分的文檔類型信息系統(tǒng)用戶文檔開發(fā)文檔管理文檔用戶手冊圖8-2按照服務(wù)目68二、信息系統(tǒng)各類文檔的內(nèi)容

盡管文檔的重要性大家都大體知道，但在實際工作中，文檔在編制和使用中仍然存在著許多問題，有待于解決。系統(tǒng)開發(fā)人員中較普遍地存在著對編制文檔不感興趣的現(xiàn)象。從用戶方面看，他們又常常抱怨：文檔售價太高、文檔不夠完整、文檔編寫得不好、文檔已經(jīng)陳舊或是文檔太多，難以使用，等等。各類文檔究竟應(yīng)該寫哪些內(nèi)容，說明什么問題，下面將大體按照信息系統(tǒng)生命周期的階段，逐一介紹上面提到的各種文檔。由于信息系統(tǒng)的分析與設(shè)計在信息系統(tǒng)的建設(shè)過程中非常重要，所以在對所有文檔分別進(jìn)行簡單介紹后，專門給出了系統(tǒng)分析說明書和系統(tǒng)分析說明書的內(nèi)容與參考格式。 二、信息系統(tǒng)各類文檔的內(nèi)容盡管文檔的重要性大家都大體知69本節(jié)內(nèi)容:1、系統(tǒng)各類文檔的內(nèi)容簡介2、系統(tǒng)分析說明書編寫指南3、系統(tǒng)設(shè)計說明書內(nèi)容指南本節(jié)內(nèi)容:70l、系統(tǒng)各類文檔的內(nèi)容簡介

信息系統(tǒng)建設(shè)過程中主要文檔有：系統(tǒng)開發(fā)立項報告、可行性研究報告、系統(tǒng)開發(fā)計劃書、系統(tǒng)分析說明書、系統(tǒng)設(shè)計說明書、程序設(shè)計報告、系統(tǒng)測試計劃與測試報告、系統(tǒng)使用與維護手冊、系統(tǒng)評價報告、系統(tǒng)開發(fā)月報與系統(tǒng)開發(fā)總結(jié)報告。下面對它們逐一介紹：l、系統(tǒng)各類文檔的內(nèi)容簡介 信息系統(tǒng)建設(shè)過程中主要文檔有71（1）系統(tǒng)開發(fā)立項報告

在信息系統(tǒng)的正式開發(fā)前。用戶單位必須提出要開發(fā)的新系統(tǒng)的目標(biāo)、功能、費用、時間、對組織機構(gòu)的影響等。如果是本單位獨立開發(fā)或聯(lián)合開發(fā)，這些內(nèi)容形成的文檔稱做立項報告，用于向領(lǐng)導(dǎo)申請經(jīng)費及支持等；如果是委托開發(fā)，則以任務(wù)委托或開發(fā)協(xié)議(合同)方式進(jìn)行說明。立項報告主要包括以下內(nèi)容：①概述：概述現(xiàn)行系統(tǒng)的組織結(jié)構(gòu)、功能、業(yè)務(wù)流程以及存在的主要問題。②新系統(tǒng)的目標(biāo)：開發(fā)新系統(tǒng)的意義和新系統(tǒng)實現(xiàn)后的功能、技術(shù)指標(biāo)、安全和保密性、新系統(tǒng)運行環(huán)境等。③經(jīng)費預(yù)算和經(jīng)費來源。④項目進(jìn)度和完成期限。⑤驗收標(biāo)準(zhǔn)和方法。⑥移交的文檔資料。⑦開始可行性研究的組織隊伍、機構(gòu)與預(yù)算。⑧其他有關(guān)需要說明的問題。（1）系統(tǒng)開發(fā)立項報告72（2）可行性研究報告

可行性研究階段的文檔是可行性研究報告。在可行性研究報告中要說明待開發(fā)項目在技術(shù)上、經(jīng)濟上和社會因素上的可行性，評述為了合理地達(dá)到開發(fā)目標(biāo)可供選擇的各種可能實施的方案，說明并論證所選定實施方案的理由?？尚行匝芯繄蟾嬷饕ㄒ韵聝?nèi)容：①概述。②新系統(tǒng)的目標(biāo)、要求和約束。③可行性研究的基本準(zhǔn)則。④現(xiàn)行系統(tǒng)描述及現(xiàn)行系統(tǒng)存在的主要問題。⑤新系統(tǒng)對現(xiàn)行系統(tǒng)的影響。⑥投資和效益分析。⑦其他可選方案及與國內(nèi)外同類方案的比較。⑧有關(guān)建議。（2）可行性研究報告73（3）系統(tǒng)開發(fā)計劃書

可行性報告被批準(zhǔn)后及在系統(tǒng)開發(fā)之前，需要擬定一份較為詳細(xì)的系統(tǒng)開發(fā)計劃，以保證系統(tǒng)開發(fā)工作按計劃保質(zhì)保量按時完成。在開始計劃書中，應(yīng)該說明各任務(wù)的負(fù)責(zé)人員、開發(fā)的進(jìn)度、開發(fā)經(jīng)費的預(yù)算、所需的硬什及軟件資源等。開發(fā)計劃書應(yīng)提供給項目管理人員，作為開發(fā)階段評審的參考。對于項目計劃的管理，可以采用MicrosoftProject等項目管理軟件進(jìn)行輔助管理。系統(tǒng)開發(fā)計劃書的主要內(nèi)容如下：

①概述：主要包括系統(tǒng)開發(fā)的主要目標(biāo)、基本方針、參加人員、工作階段和內(nèi)容等。②開發(fā)計劃：系統(tǒng)開發(fā)各工作階段或子項目的任務(wù)、分工、負(fù)責(zé)人、計劃時間(開始及結(jié)束時間)、人力與資金及設(shè)備消耗、實際執(zhí)行情況等?？捎霉ぷ鬟M(jìn)度表、甘特圖、網(wǎng)絡(luò)圖及關(guān)鍵路徑法等工具輔助管理。③驗收標(biāo)準(zhǔn)：每項工作完成后驗收的標(biāo)準(zhǔn)(時間、資金、質(zhì)量等)。④協(xié)調(diào)方法：信息系統(tǒng)開發(fā)中各個單位、階段之間的銜接、協(xié)調(diào)的方法、負(fù)責(zé)人、權(quán)限等。（3）系統(tǒng)開發(fā)計劃書74（4）系統(tǒng)分析說明書當(dāng)信息系統(tǒng)的開發(fā)采用委托方式進(jìn)行開發(fā)時，用戶需求說明書(或叫用戶需求報告)是開發(fā)單位與用戶間交流的橋梁，同時也是系統(tǒng)設(shè)計的基礎(chǔ)和依據(jù)。當(dāng)采用獨立開發(fā)或合作開發(fā)時，系統(tǒng)分析是系統(tǒng)開發(fā)中最重要的工作，其工作成果就是系統(tǒng)分析說明書(或叫系統(tǒng)分析報告)。系統(tǒng)分析工作的好壞決定了新系統(tǒng)的成敗。從信息系統(tǒng)生命周期的角度來看，用戶需求說明書就是系統(tǒng)分析說明書。系統(tǒng)分析說明書的主要內(nèi)容一般包括：①概述。②系統(tǒng)需求。③新系統(tǒng)目標(biāo)與新系統(tǒng)的功能。④新系統(tǒng)的邏輯模型。⑤新系統(tǒng)的運行環(huán)境。⑥新系統(tǒng)的驗收標(biāo)準(zhǔn)與培訓(xùn)計劃。（4）系統(tǒng)分析說明書75（5）系統(tǒng)設(shè)計說明書

在系統(tǒng)分析的基礎(chǔ)上，根據(jù)系統(tǒng)分析說明書進(jìn)行新系統(tǒng)的物理設(shè)計，并完成系統(tǒng)設(shè)計說明書(或叫系統(tǒng)設(shè)計報告)的撰寫。系統(tǒng)設(shè)計說明書主要包括以下內(nèi)容：①概述。 ⑥輸入與輸出設(shè)計。②總體結(jié)構(gòu)。 ⑦計算機處理過程設(shè)計。③計算機系統(tǒng)配置。⑧接口及通信環(huán)境設(shè)計。④代碼設(shè)計。 ⑨安全和保密設(shè)計。⑤數(shù)據(jù)庫設(shè)計。 ⑩數(shù)據(jù)準(zhǔn)備。

（5）系統(tǒng)設(shè)計說明書76（6）程序設(shè)計報告

依據(jù)系統(tǒng)設(shè)計報告，進(jìn)行程序設(shè)計工作。程序設(shè)計經(jīng)調(diào)試通過后，應(yīng)完成程序設(shè)計報告，以便為系統(tǒng)調(diào)試和系統(tǒng)維護工作提供依據(jù)。有了程序設(shè)計報告，就可以避免因程序員的流動造成系統(tǒng)維護工作的困難。程序設(shè)計報告的主要內(nèi)容如下：①概述。 ⑤程序流程圖。②程序結(jié)構(gòu)圖。 ⑥源程序。③程序控制圖。 ⑦程序注釋說明。④算法。（6）程序設(shè)計報告77（7）系統(tǒng)測試計劃與測試報告為做好組裝測試和確認(rèn)測試，需為如何組織測試制定實施計劃。測試計劃應(yīng)包括測試的內(nèi)容、進(jìn)度、條件、人員、測試用例的選取原則、測試結(jié)果允許的偏差范圍等。測試工作完成以后，應(yīng)提交測試計劃執(zhí)行情況的說明。對測試結(jié)果加以分析，并提出測試的結(jié)論意見。系統(tǒng)測試是系統(tǒng)實施階段的重要工作。系統(tǒng)測試報告主要內(nèi)容如下：①概述：說明系統(tǒng)測試的目的。②測試環(huán)境：有關(guān)軟硬件、通信、數(shù)據(jù)庫、人員等情況。③測試內(nèi)容：系統(tǒng)、子系統(tǒng)、模塊的名稱，性能技術(shù)指標(biāo)等。④測試方案：測試的方法、測試數(shù)據(jù)、測試步驟、測試中故障的解決方案等。⑤測試結(jié)果：測試的實際情況、結(jié)果等。⑥結(jié)論：系統(tǒng)功能評價、性能技術(shù)指標(biāo)評價、結(jié)論。（7）系統(tǒng)測試計劃與測試報告78（8）系統(tǒng)使用與維護手冊

系統(tǒng)使用與維護手冊是為用戶準(zhǔn)備的文檔。有的系統(tǒng)比較大，將使用手冊與維護手冊分開。其中，系統(tǒng)使用手冊(或叫操作手冊)一般是面向業(yè)務(wù)人員的，他們是系統(tǒng)的最終使用者。系統(tǒng)維護手冊(或叫技術(shù)手冊)是供具有一定信息技術(shù)專業(yè)知識的系統(tǒng)維護人員使用的。系統(tǒng)使用與維護手冊的主要內(nèi)容包括：①概述：主要包括系統(tǒng)功能、系統(tǒng)運行環(huán)境(軟、硬件)、系統(tǒng)安裝等內(nèi)容。②使用說明：系統(tǒng)操作使用說明較為詳細(xì)地說明了操作的目的、過程、方式、輸入輸出的數(shù)據(jù)等。最好將系統(tǒng)操作的界面圖放入說明書，便于使用者學(xué)習(xí)與操作。③問題解釋：解釋了系統(tǒng)使用中可能出現(xiàn)的問題及解決辦法，如非常規(guī)操作命令、系統(tǒng)恢復(fù)過程及意外情況與開發(fā)單位的聯(lián)系方式等。信息系統(tǒng)運行過程中，用戶還需要記錄運行日志。在發(fā)現(xiàn)需要對系統(tǒng)修正、更改的問題時，應(yīng)將存在的問題、修改的考慮以及修改的影響估計作詳細(xì)的描述，寫成維護修改建議書(或叫維護修改申請書)，提交審批。維護修改建議書也是系統(tǒng)運行維護期間的重要文檔。（8）系統(tǒng)使用與維護手冊79（9）系統(tǒng)評價報告

系統(tǒng)評價報告主要是根據(jù)系統(tǒng)可行性研究報告、系統(tǒng)分析說明書、系統(tǒng)設(shè)計說明書所確定的新系統(tǒng)的目標(biāo)、功能、性能、計劃執(zhí)行情況及新系統(tǒng)實現(xiàn)后的經(jīng)濟效益和社會效益等給予評價。如果該信息系統(tǒng)的開發(fā)已作為立項的科研項目，那么，還要請專家進(jìn)行鑒定。系統(tǒng)評價報告主要包括：①概述。②系統(tǒng)構(gòu)成。③系統(tǒng)達(dá)到設(shè)計目標(biāo)的情況。④系統(tǒng)的可靠性、安全性、保密性、可維護性等狀況。⑤系統(tǒng)的經(jīng)濟效益與社會效益的評價。⑥總結(jié)性評價。

有的項目聘請了相應(yīng)的監(jiān)理方與審計機構(gòu)，那么還需要有相應(yīng)的系統(tǒng)監(jiān)理報告和系統(tǒng)審計報告，這兩種報告的內(nèi)容大體與系統(tǒng)評價報告相同。（9）系統(tǒng)評價報告80（10）系統(tǒng)開發(fā)月報與系統(tǒng)開發(fā)總結(jié)報告信息系統(tǒng)項目的建設(shè)開始以后，各任務(wù)的負(fù)責(zé)人應(yīng)該按月向管理部門提交相應(yīng)的項目進(jìn)展情況報告。報告應(yīng)包括進(jìn)度計劃與實際執(zhí)行情況的比較、階段成果、遇到的問題和解決的辦法以及下個月的打算等。在整個信息系統(tǒng)項目開發(fā)已經(jīng)完成，并且系統(tǒng)正式運行一段時間以后，系統(tǒng)開發(fā)人員應(yīng)與項目實施計劃對照、總結(jié)實際執(zhí)行的情況，如進(jìn)度、成果、資源利用、成本和投入的人力，從而對開發(fā)工作做出評價，總結(jié)出經(jīng)驗和教訓(xùn)，形成系統(tǒng)開發(fā)總結(jié)報告。系統(tǒng)開發(fā)總結(jié)報告包括以下內(nèi)容：①概述：包括信息系統(tǒng)的提出者、開發(fā)者、用戶；系統(tǒng)開發(fā)的主要依據(jù)：系統(tǒng)開發(fā)的目的：系統(tǒng)開發(fā)的可行性分析等。②信息系統(tǒng)項目的完成情況：包括系統(tǒng)構(gòu)成與主要功能；系統(tǒng)性能與技術(shù)指標(biāo)：計劃與實際進(jìn)度對比：費用預(yù)算與實際費用的對比等。③系統(tǒng)評價：系統(tǒng)的主要特點；采用的技術(shù)方法與評價；系統(tǒng)工作效率與質(zhì)量；存在的問題與原因：用戶的評價與反饋意見。④經(jīng)驗與教訓(xùn)：系統(tǒng)開發(fā)過程中的經(jīng)驗與教訓(xùn)：對今后工作的建議：對外發(fā)表的論文。（10）系統(tǒng)開發(fā)月報與系統(tǒng)開發(fā)總結(jié)報告81 總而言之，信息系統(tǒng)的文檔是系統(tǒng)建設(shè)中的重要組成部分，對于系統(tǒng)開發(fā)的成功和系統(tǒng)維護的正常起著保證和支持作用。對各階段產(chǎn)生的文檔要參照國家軟件開發(fā)規(guī)范進(jìn)行填寫并按照統(tǒng)一的格式進(jìn)行編號(本章附錄中詳細(xì)介紹了國家標(biāo)準(zhǔn)《計算機軟件產(chǎn)品開發(fā)文件編制指南》)。文檔的多少和大小、復(fù)雜程度與所開發(fā)的信息系統(tǒng)的大小和復(fù)雜程度成正比。另外，信息系統(tǒng)的文檔還因開發(fā)方法的不同而有所差異。用戶可根據(jù)實際情況確定信息系統(tǒng)開發(fā)的文檔種類和內(nèi)容。文檔要盡可能地簡單明了，便于閱讀，并且盡量使用圖、表進(jìn)行說明。 總而言之，信息系統(tǒng)的文檔是系統(tǒng)建設(shè)中的重要組成部分，對822、系統(tǒng)分析說明書編寫指南系統(tǒng)分析說明書內(nèi)容：引言項目概述實施總計劃2、系統(tǒng)分析說明書編寫指南系統(tǒng)分析說明書內(nèi)容：83引言（1）摘要：摘要說明所建議開發(fā)的系統(tǒng)的名稱、目標(biāo)和功能。（2）背景。

①項目的承擔(dān)者。

②用戶。

③本系統(tǒng)和其他系統(tǒng)或機構(gòu)的關(guān)系和聯(lián)系。（3）參考和引用資料。

①本項目經(jīng)核準(zhǔn)的計劃任務(wù)書或合同及上級機關(guān)的批文。

②屬于本項目的其他已發(fā)表的文件。

③本文件中各處引用的文件資料：列出文件資料的標(biāo)題、編號、發(fā)表日期和制定單位。說明這些文件資料的來源。（４）專門術(shù)語定義：列出本文件所用到的術(shù)語。引言（1）摘要：摘要說明所建議開發(fā)的系統(tǒng)的名稱、目標(biāo)和84項目概述（1）項目的主要工作內(nèi)容。簡要地說明本項目在開發(fā)中須進(jìn)行的各項主要工作。這些工作是建立新系統(tǒng)邏輯模型的必要條件。而邏輯模型是書寫系統(tǒng)說明書的基礎(chǔ)。（2）系統(tǒng)需求說明。新系統(tǒng)是在現(xiàn)行系統(tǒng)的基礎(chǔ)上建立起來的。在新系統(tǒng)設(shè)計工作開展之前，必須對系統(tǒng)調(diào)查清楚，掌握現(xiàn)行系統(tǒng)的真實情況，了解用戶的新要求和問題所在。

①現(xiàn)行系統(tǒng)的現(xiàn)狀調(diào)查說明：列出現(xiàn)行系統(tǒng)的目標(biāo)、主要功能、用戶要求等，并簡要指出問題所在。

②業(yè)務(wù)流程說明：簡要說明現(xiàn)行系統(tǒng)現(xiàn)場工作流程和事務(wù)流程概況。若需要反映這些業(yè)務(wù)流程的業(yè)務(wù)流程圖，可以另附。項目概述（1）項目的主要工作內(nèi)容。85（3）系統(tǒng)功能說明。

在現(xiàn)行系統(tǒng)現(xiàn)狀調(diào)查的基礎(chǔ)上，進(jìn)一步透過具體工作，分析組織內(nèi)的信息、數(shù)據(jù)流動的路徑和過程，真正弄清用戶要解決什么問題，明確系統(tǒng)的功能要求。數(shù)據(jù)流程圖是系統(tǒng)需求的高度概括，是調(diào)查研究的重要產(chǎn)物。它源于現(xiàn)行系統(tǒng)，又高于現(xiàn)行系統(tǒng)。這里主要通過數(shù)據(jù)流程圖概況說明系統(tǒng)的功能要求。

①新系統(tǒng)的目標(biāo)：從新系統(tǒng)數(shù)據(jù)流程圖的分析中，說明新系統(tǒng)有哪些目標(biāo)。

②新系統(tǒng)的功能要求：列出系統(tǒng)的主要功能。

③驗收：簡單說明驗收要求。（3）系統(tǒng)功能說明。86（4）系統(tǒng)的數(shù)據(jù)要求說明。

從數(shù)據(jù)流程圖和數(shù)據(jù)字典分析邏輯數(shù)據(jù)結(jié)構(gòu)，標(biāo)識每個數(shù)據(jù)結(jié)構(gòu)中的每個數(shù)據(jù)項、記錄和文件的長度以及它們之間的關(guān)系。

①系統(tǒng)的數(shù)據(jù)要求：這里的數(shù)據(jù)是指靜態(tài)數(shù)據(jù)，即在運行過程中主要作為參考的數(shù)據(jù)，它們在很長一段時間內(nèi)不會變化，一般不隨運行而改變。

A．?dāng)?shù)據(jù)項定義：說明數(shù)據(jù)項定義中出現(xiàn)的例外情況，列出作為控制或參考的主要數(shù)據(jù)項。

B．容量：本系統(tǒng)所有數(shù)據(jù)項的總長度。

C．用戶。

D．驗收：指出驗收情況。

②系統(tǒng)的數(shù)據(jù)要求的粗略估計：粗略估算系統(tǒng)在運行過程中動態(tài)數(shù)據(jù)的內(nèi)容。（4）系統(tǒng)的數(shù)據(jù)要求說明。87實施總計劃（1）工作任務(wù)的分解。對于項目開發(fā)中應(yīng)完成的各項工作，按系統(tǒng)功能(或子系統(tǒng))劃分，指定專人(或小組)分工完成，指明每項任務(wù)的負(fù)責(zé)人。（2）進(jìn)度。

給出每項工作任務(wù)的預(yù)定開始日期和完成日期，規(guī)定各項工作任務(wù)完成的先后順序以及每項工作任務(wù)完成的界面。（3）預(yù)算。

逐項列出本開發(fā)項目所需要的勞務(wù)(包括工作量/人)以及經(jīng)費的預(yù)算（包括辦公費、差旅費、資料費等）。實施總計劃（1）工作任務(wù)的分解。883、系統(tǒng)設(shè)計說明書內(nèi)容指南

引言（1）摘要（2）背景（3）工作條件/限制（4）參考和引用資料（5）專門術(shù)語定義

系統(tǒng)總體技術(shù)方案（1）模塊設(shè)計。（2）代碼設(shè)計。（3）輸入設(shè)計。（4）輸出設(shè)計。（5）數(shù)據(jù)庫設(shè)計說明。（6）模型庫及方法庫設(shè)計。（7）網(wǎng)絡(luò)設(shè)計：系統(tǒng)的網(wǎng)絡(luò)結(jié)構(gòu)，功能的設(shè)計。（8）安全保密設(shè)計。（9）實施方案說明書。3、系統(tǒng)設(shè)計說明書內(nèi)容指南引言89（1）摘要：摘要說明所設(shè)計的系統(tǒng)的名稱、目標(biāo)和功能。（2）背景。

①項目的承擔(dān)者。

②用戶。

③本項目和其他系統(tǒng)或機構(gòu)的關(guān)系和聯(lián)系。（3）工作條件/限制：說明本項目開發(fā)中所具備的工作條件和受到的限制。

①硬件/軟件/運行環(huán)境方面的限制。

②保密和安全的限制。

③有關(guān)部門的業(yè)務(wù)人員提供確切的數(shù)據(jù)及其定義。

④有關(guān)系統(tǒng)軟件文本。

⑤網(wǎng)絡(luò)協(xié)議標(biāo)準(zhǔn)文本。

⑥國家安全保密條例。（4）參考和引用資料

①本項目的已核準(zhǔn)的計劃任務(wù)書或合同和上級機關(guān)的批文。

②屬于本項目的其他已發(fā)表的文件。

③本文件中引用的文件資料：列出文件資料的標(biāo)題、編號、發(fā)表日期和制定單位。說明這些文件資料的來源。（5）專門術(shù)語定義：列出本文件所用到的術(shù)語。引言（1）摘要：摘要說明所設(shè)計的系統(tǒng)的名稱、目標(biāo)和功能。90系統(tǒng)總體設(shè)計方案（1）模塊設(shè)計。模塊設(shè)計階段中，在系統(tǒng)內(nèi)部劃分成各個基礎(chǔ)部分——模塊結(jié)構(gòu)，確定系統(tǒng)的總體結(jié)構(gòu)?？傮w結(jié)構(gòu)與各個分層模塊結(jié)構(gòu)的關(guān)系是程序?qū)嵤┑闹匾罁?jù)。模塊結(jié)構(gòu)采用模塊結(jié)構(gòu)圖來表示。模塊結(jié)構(gòu)是采用HIPO圖(即分層加輸入一處理一輸出圖)形式繪制而成的框圖。

①名稱：列出系統(tǒng)中各主要功能的結(jié)構(gòu)圖名稱和它們之間的關(guān)系。

②功能：用文字簡單說明主要模塊結(jié)構(gòu)圖應(yīng)具有的功能。

③功能說明：說明是用偽碼形式還是用結(jié)構(gòu)英語形式，或者其他自然語言形式描述模塊結(jié)構(gòu)圖的。

④評價

⑤驗收：指設(shè)計人員驗收的決定和處理情況。系統(tǒng)總體設(shè)計方案（1）模塊設(shè)計。91（2）代碼設(shè)計。代碼設(shè)計是信息系統(tǒng)所必需的前提條件，是不可缺少的重要的內(nèi)容。它是進(jìn)行信息分類、校對、總計和檢查的關(guān)鍵，它也用于指定數(shù)據(jù)的處理方法，區(qū)別數(shù)據(jù)類型，并指定計算機處理的內(nèi)容。

①代碼的方式和種類：簡單說明代碼的方式和種類。

②功能：從編碼的原則要求(如單義性、可讀性等)去簡單說明代碼所體現(xiàn)的功能。

③評價：從識別信息、信息標(biāo)準(zhǔn)化、節(jié)省存儲單元、提高運算速度、節(jié)省計算機的處理費用以及代碼的特性進(jìn)行評價。

④驗收。系統(tǒng)總體設(shè)計方案（2）代碼設(shè)計。系統(tǒng)總體設(shè)計方案92（3）輸入設(shè)計。

輸入設(shè)計擔(dān)負(fù)著將系統(tǒng)外的數(shù)據(jù)以一定的格式送入計算機的任務(wù)，它直接影響到人工系統(tǒng)和機器系統(tǒng)的工作質(zhì)量。輸入設(shè)計的基點是確保向信息系統(tǒng)提供正確的信息。輸入必須有必要的介質(zhì)和設(shè)備。

①輸入項目：說明對本系統(tǒng)的主要輸入項目。

②輸入的承擔(dān)者：說明對數(shù)據(jù)輸入工作的承擔(dān)者的安排，并指出操作人員、維