【正文】 [項(xiàng)目名稱(chēng) ] 用戶手冊(cè)概要 [(版本號(hào) )] 擬 制 人 ______________________ 審 核 人 ______________________ 批 準(zhǔn) 人 ______________________ [一九九九年八月二十日 ] 軟件開(kāi)發(fā)項(xiàng)目文檔模板大全 25 用戶手冊(cè)概要 1． 引言 [?? ] [?? ] [?? ] [?? ] 2． 用途 [?? ] [?? ] [?? ] [?? ] [?? ] 3． 運(yùn)行環(huán)境 [?? ] [?? ] [?? ] 軟件開(kāi)發(fā)項(xiàng)目文檔模板大全 26 4． 使用過(guò)程 與初始化 [?? ] [?? ] [?? ] [?? ] [?? ] [?? ] [?? ] [?? ] [?? ] [?? ] 軟件開(kāi)發(fā)項(xiàng)目文檔模板大全 27 [項(xiàng)目名稱(chēng) ] 概要設(shè)計(jì)說(shuō)明書(shū) [(版本號(hào) )] 擬 制 人 ______________________ 審 核 人 ______________________ 批 準(zhǔn) 人 ______________________ [一九九九年八月二十日 ] 軟件開(kāi)發(fā)項(xiàng)目文檔模板大全 28 概要設(shè)計(jì)說(shuō)明書(shū) 1． 引言 [說(shuō)明編寫(xiě)這份概要設(shè)計(jì)說(shuō)明書(shū)的目的，指出預(yù)期的讀者。 ] [列出本文件中用到的專(zhuān)門(mén)術(shù)語(yǔ)的定義和外文首字母組詞的原詞組。 ] 2．總體設(shè)計(jì) [說(shuō)明對(duì)本系統(tǒng)的主要的輸入輸出項(xiàng)目、處理的功能性能要求。 ] [列出運(yùn)行該軟件所需要的硬設(shè)備。 ] 軟件 [列出支持軟件，包括要用到的操作系統(tǒng)、編譯（或匯編）程序、測(cè)試支持軟件等。 ] [說(shuō)明本系統(tǒng)的基本設(shè)計(jì)概念和處理流程，盡量使用圖表的形式。 ] [本條用一張矩陣圖說(shuō)明各項(xiàng)功能需求的實(shí)現(xiàn)同各模塊的分配關(guān)系。 ] [說(shuō)明在概要設(shè)計(jì)過(guò)程中尚未解決而設(shè)計(jì)者認(rèn)為在系統(tǒng)完成之前必須解決的各個(gè)問(wèn)題。 ] [說(shuō)明提供給用戶操作的硬件控制面板的定義。 ] 軟件開(kāi)發(fā)項(xiàng)目文檔模板大全 30 [說(shuō)明本系統(tǒng)之內(nèi)的各個(gè)系統(tǒng)元素之間的接口的安排。 ] [說(shuō)明每一種外界的運(yùn)行控制的方式方法和操 作步驟。 ] 5．系統(tǒng)數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì) [不涉及軟件設(shè)計(jì)可不包含 ] [給出本系統(tǒng)內(nèi)軟件所使用的每個(gè)數(shù)據(jù)結(jié)構(gòu)的名稱(chēng)、標(biāo)識(shí)符以及它們之中每個(gè)數(shù)據(jù)項(xiàng)、記錄、文卷和系的標(biāo)識(shí)、定義、長(zhǎng)度及它們之間的層次的或表格的相互關(guān)系。 ] [說(shuō)明各 個(gè)數(shù)據(jù)結(jié)構(gòu)與訪問(wèn)這些數(shù)據(jù)結(jié)構(gòu)的各個(gè)程序之間的對(duì)應(yīng)關(guān)系。 ] 軟件開(kāi)發(fā)項(xiàng)目文檔模板大全 31 [說(shuō)明故障出現(xiàn)后可能采取的變通措施。 ] [說(shuō)明準(zhǔn)備采用的后備技術(shù)，使用另一個(gè)效率稍低的系統(tǒng)或方法來(lái)求得所需結(jié)果的某些部分，例如一個(gè)自動(dòng)系統(tǒng)的降效技術(shù)可以是手工操作和數(shù)據(jù)的人工記錄。 ] [說(shuō)明為了系統(tǒng)維護(hù)的方便而在程序內(nèi)部設(shè)計(jì)中作出的安排，包括在程序中專(zhuān)門(mén)安排用于系統(tǒng)的檢查與維護(hù)的檢測(cè)點(diǎn)和專(zhuān)用模塊。 ] a.[待開(kāi)發(fā)數(shù)據(jù)庫(kù)的名稱(chēng)和使用此數(shù)據(jù)庫(kù)的軟件系統(tǒng)的名稱(chēng)； ] b.[列出本項(xiàng)目的任務(wù)提出者、開(kāi)發(fā)者、用戶。 ] [列出有關(guān)的參考資料。如果該數(shù)據(jù)庫(kù)屬于尚在實(shí)驗(yàn)中、尚在測(cè)試中或是暫時(shí)使用的，則要說(shuō)明這一特點(diǎn)及其有效時(shí)間范圍。 ] [陳述一個(gè)程序員或一個(gè)系統(tǒng)分析員為了能使用此數(shù)據(jù)庫(kù)而需要了解的 建立標(biāo)號(hào)、標(biāo)識(shí)的約定。 ] [簡(jiǎn)單介紹同此數(shù)據(jù)庫(kù)直接有關(guān)的支持軟件。列出這些支持軟件的技術(shù)文件的標(biāo)題、編號(hào)及來(lái)源 ] 3． 結(jié)構(gòu)設(shè)計(jì) 軟件開(kāi)發(fā)項(xiàng)目文檔模板大全 34 [說(shuō)明本數(shù)據(jù)庫(kù)將反映的現(xiàn)實(shí)世界中的實(shí)體、屬性和它們之間的關(guān)系等的原始數(shù)據(jù)形式，包括各數(shù)據(jù)項(xiàng)、記錄、系、文卷的標(biāo)識(shí)符、定義、類(lèi)型、度量單位和值域，建立本數(shù)據(jù)庫(kù)的每一幅用戶視圖。 ] [建立系統(tǒng)程序員視圖。 ] [說(shuō)明在數(shù)據(jù)庫(kù)的設(shè)計(jì)中，將如何通過(guò)區(qū)分不同的訪問(wèn)者、不同的訪問(wèn)類(lèi)型和不同的數(shù)據(jù)對(duì)象，進(jìn)行分別對(duì)待而獲得的數(shù)據(jù)庫(kù)安全保密的設(shè)計(jì)考慮。 ； 、開(kāi)發(fā)者、用戶。 列出有關(guān)的參考資料。 ] [列出組裝測(cè)試和確認(rèn)測(cè)試中的每一項(xiàng)測(cè)試內(nèi)容的名稱(chēng)標(biāo)識(shí)符、這些測(cè)試的進(jìn)度安排以及這些測(cè)試的內(nèi)容和目的。 ] [給出對(duì)這項(xiàng)測(cè)試的進(jìn)度安排，包括進(jìn)行測(cè)試的日期和工作內(nèi)容。包括： ] 列出本項(xiàng)測(cè)試所需的 資料。規(guī)定培訓(xùn)的內(nèi)容、受訓(xùn)的人員及從事培訓(xùn)的工作人員。 3 條相類(lèi)似的方式說(shuō)明用于另一項(xiàng)及其后各項(xiàng)測(cè)試內(nèi)容的測(cè)試工作計(jì)劃。 ] [說(shuō)明本測(cè)試的控制方式。 ] [說(shuō)明預(yù)期的輸出數(shù)據(jù)。 ] 2（標(biāo)識(shí)符） [用與本測(cè)試計(jì)劃 3。 ] [。 ] 4．評(píng)價(jià)準(zhǔn)則 [說(shuō)明所選擇的測(cè)試用例能夠檢查的范圍及其局限性。 ] [說(shuō)明用來(lái)判斷測(cè)試工作是否能通過(guò)的評(píng)價(jià)尺度，如合理和輸出結(jié)果的類(lèi)型、測(cè)試輸出結(jié)果與預(yù)期輸出之間的容許偏離范圍、允許中斷或停機(jī)的最大數(shù)。 ] c.[待開(kāi)發(fā)系統(tǒng)的名稱(chēng)； ] d.[列出本項(xiàng)目的任務(wù)提出者、開(kāi)發(fā)者、用戶。 ] [列出有關(guān)的參考資料。用一系列圖表列出系統(tǒng)內(nèi)的每個(gè)模塊的名稱(chēng)、標(biāo)識(shí)符和它們之間的層次結(jié)構(gòu)關(guān)系。以下給出的提綱是針對(duì)一般情況的。 ] [給出對(duì)該基本模塊的簡(jiǎn)要描述，主要說(shuō)明安排設(shè)計(jì)本模塊的目的意義，并且，還要說(shuō)明本模塊的特點(diǎn)。 ] [說(shuō)明對(duì)該模塊的全部性能要求。 ] [給出對(duì) 每一個(gè)輸出項(xiàng)的特性。 ] [對(duì)于硬件設(shè)計(jì)，應(yīng)詳細(xì)說(shuō)明本模塊的設(shè)計(jì)原理、元器件的選取、各元器件的邏輯關(guān)系，軟件開(kāi)發(fā)項(xiàng)目文檔模板大全 40 所需要的各種協(xié)議等。 ] [說(shuō)明本模塊與其它相關(guān)模塊間的邏輯連接方式，說(shuō)明涉及到的參數(shù)傳遞方式。 ] [說(shuō)明安排的 程序注釋。 ] [說(shuō)明對(duì)本模塊進(jìn)行單體測(cè)試的計(jì)劃，包括對(duì)測(cè)試的技術(shù)要求、輸入數(shù)據(jù)、預(yù)期結(jié)果、進(jìn)度安排、人員職責(zé)、設(shè)備條件、驅(qū)動(dòng)程序及樁模塊等的規(guī)定。 ] 4． 模塊 2（標(biāo)識(shí)符）設(shè)計(jì)說(shuō)明 [用類(lèi)似第 3條的方式，說(shuō)明第 2個(gè)模塊乃至第 N個(gè)模塊的設(shè)計(jì)考慮。可以從系統(tǒng)設(shè) 計(jì)說(shuō)明書(shū)中摘錄。 ] 4．設(shè)計(jì)說(shuō)明 [說(shuō)明本模塊的設(shè)計(jì)考慮 ] 5．硬件部分的設(shè)計(jì)結(jié)果 1） 經(jīng)項(xiàng)目組調(diào)試通過(guò)的硬件成品 1件 2）設(shè)計(jì)文件： 《原理圖》 《 PCB圖》 《 BOM清單》 《可編程器件及燒錄進(jìn)制文件》 《必要測(cè)試點(diǎn)波形圖或硬件指標(biāo)評(píng)細(xì)說(shuō)明》 《原理詳細(xì)說(shuō)明》 《與系統(tǒng)內(nèi)其他部分接口軟硬件詳細(xì)說(shuō)明》 這些文件可以附件的形式列后。 7． 測(cè)試說(shuō)明 說(shuō)明直接要經(jīng)過(guò)本模塊的每一項(xiàng)測(cè)試，包括這些測(cè)試各自的標(biāo)識(shí)符和編號(hào)、進(jìn)行這些測(cè)試的目的、所用的配置和輸入、預(yù)期的輸出及實(shí)際的輸出。 軟件開(kāi)發(fā)項(xiàng)目文檔模板大全 44 單元測(cè)試報(bào)告 填表日期： 編號(hào)： 開(kāi)發(fā)項(xiàng)目名稱(chēng) 開(kāi)發(fā)項(xiàng)目編號(hào) 第一責(zé)任人 單元名稱(chēng) 責(zé)任人 單元所屬子系統(tǒng) 開(kāi)發(fā)周期 代碼測(cè)試檢查： 代碼測(cè)試內(nèi)容 測(cè)試 人員 測(cè)試結(jié)果 備注 路徑測(cè)試 聲明測(cè)試 循環(huán)測(cè)試 邊界測(cè)試 接口測(cè)試 界面測(cè)試 數(shù)據(jù)確認(rèn)測(cè)試 代碼走查 功能測(cè)試： 序號(hào) 功能名稱(chēng) 操作方法 結(jié)果 建議 測(cè)試人員 備注 測(cè)試結(jié)論 責(zé)任人 項(xiàng)目第一責(zé)任人 審核 項(xiàng)目組 測(cè)試組 總工辦 總工程師