軟件開發(fā)的管理文檔應(yīng)包含以下幾個(gè)方面

軟件文檔編寫向?qū)臋n分類項(xiàng)目包括如下幾類文檔：項(xiàng)目管理文檔。包括：《軟件項(xiàng)目計(jì)劃》'《項(xiàng)目進(jìn)度報(bào)告》、《項(xiàng)目開發(fā)總結(jié)報(bào)告》軟件開發(fā)文檔。包括：《需求規(guī)格說明》'《概要設(shè)計(jì)說明》'《詳細(xì)設(shè)計(jì)說明》。軟件測(cè)試文檔。包括：《測(cè)試計(jì)劃》、《軟件測(cè)試分析報(bào)告》。產(chǎn)品資料。包括：《用戶操作手冊(cè)》。下表是一個(gè)文檔渭單。文檔類型編碼編號(hào)注釋項(xiàng)目管理項(xiàng)目開發(fā)計(jì)劃PP1002ProjectPIan項(xiàng)目進(jìn)度報(bào)告PR1003ProjectReport軟件開發(fā)軟件項(xiàng)目計(jì)劃SP2N01SoftwarePIan軟件需求規(guī)格說明SA2N02SoftwareAnIaysis軟件設(shè)計(jì)說明SD2N03SoftwareDesign軟件測(cè)試軟件測(cè)試計(jì)劃TP4N01TestingPIan軟件測(cè)試分析報(bào)告TR4N02TesingReport產(chǎn)品文檔用戶手冊(cè)RU5N01Userguide所有文檔的標(biāo)識(shí)渭單要在《項(xiàng)目開發(fā)計(jì)劃》中予以具體定義。文檔的版本號(hào)本項(xiàng)目文檔的版本號(hào)由以圓點(diǎn)隔開的兩個(gè)數(shù)字組成，第一個(gè)數(shù)字表示出版號(hào)，第二個(gè)數(shù)字表示該版的修訂號(hào)。具體用法如下：當(dāng)文檔初版時(shí)，版本號(hào)為V1.0；當(dāng)文檔被局部修訂時(shí)，出版號(hào)不變，修訂號(hào)增1。例如，對(duì)初版文檔作了第一次修訂，則版本號(hào)為V1.1；當(dāng)文檔被全面改寫或局部修訂累積較多導(dǎo)致文檔發(fā)生全局變化時(shí)，出版號(hào)增1。例如，在V1.5版的基礎(chǔ)上作了一次全面修訂，則新版本號(hào)為V2.0。文檔的標(biāo)識(shí)項(xiàng)目所產(chǎn)生的文檔都有唯一、特定的編碼，其構(gòu)成如下：項(xiàng)目標(biāo)志-任務(wù)標(biāo)識(shí)-文檔類型-文檔樹中的編號(hào)-版本號(hào)/序號(hào)其中：項(xiàng)目標(biāo)志：本項(xiàng)目的標(biāo)識(shí)，表明本項(xiàng)目是“XXXX”°任務(wù)標(biāo)識(shí)：少于八個(gè)字母，簡(jiǎn)要標(biāo)識(shí)本任務(wù)，標(biāo)準(zhǔn)XXXX是“STANDAR”D。適用于整個(gè)項(xiàng)目的文檔，此標(biāo)識(shí)為“XXXX”°文檔類型：取自下表的兩位字母編碼。編號(hào)：反映文檔類型（根據(jù)下表填寫）版本號(hào)：本文檔的版本號(hào)。序號(hào)：四位數(shù)字編碼，指明該文檔在項(xiàng)目文檔庫的總序號(hào)。一個(gè)文檔編碼的例子為：XXXX-XXXX-SP-2N01-V1.0/0015文檔的編寫模板項(xiàng)目中所有任務(wù)的文檔將按照統(tǒng)一的模板（格式和內(nèi)容的約定）來編寫，包括：《模板-軟件開發(fā)計(jì)劃》《模板-軟件需求規(guī)格說明》《模板-軟件設(shè)計(jì)說明》《模板-技術(shù)說明》文檔的模板均保存在配置管理員處，井由其分發(fā)給文檔的編寫者。需要說明的是，文檔模板是項(xiàng)目在文檔結(jié)構(gòu)和版式上的統(tǒng)一約定，對(duì)于具體文檔，編寫者可以根據(jù)需要添加章節(jié)，原則上不要?jiǎng)h除章節(jié)（可以寫“本章/節(jié)無內(nèi)容”）。當(dāng)文檔模板不符合編寫者要求時(shí)，編寫者應(yīng)與項(xiàng)目組長(zhǎng)聯(lián)系以決定文檔的編寫標(biāo)準(zhǔn)。關(guān)于《技術(shù)說明》在產(chǎn)品包中，應(yīng)包含一份《技術(shù)說明》，以詳細(xì)說明本產(chǎn)品的代碼來源和修改情況。在《技術(shù)說明》中，應(yīng)包含如下內(nèi)容：代碼包的清單，格式為：代碼包名來源版本功能的描述其中，“來源”可以是：下載的網(wǎng)絡(luò)地址、“拷貝”、“創(chuàng)建”。代碼文件的清單，格式為:代碼包名文件名狀態(tài)修改者/作者最后修改時(shí)間其中，“狀態(tài)”可以是：“修改”、“刪除”、“創(chuàng)建”、“原樣”。封面格式:文檔編號(hào)

版本號(hào)文檔名稱：項(xiàng)目名稱：項(xiàng)目負(fù)責(zé)人：編寫年月日校對(duì)年月日審核年月日批準(zhǔn)開發(fā)單位年月日系統(tǒng)規(guī)格說明書(SystemSpecification)一引言A文檔的范圍和目的B概述1目標(biāo)二功能和數(shù)據(jù)描述A系統(tǒng)結(jié)構(gòu)1結(jié)構(gòu)關(guān)系圖2結(jié)構(gòu)關(guān)系圖描述—子系統(tǒng)描述A子系統(tǒng)的結(jié)構(gòu)圖規(guī)格說B"結(jié)構(gòu)字典C結(jié)構(gòu)連接圖和說明四系統(tǒng)建模和模擬結(jié)構(gòu)A用于模擬的系統(tǒng)模型B模擬結(jié)果C特殊性能五軟件項(xiàng)目問題A軟件項(xiàng)目計(jì)劃六^附錄軟件項(xiàng)目計(jì)劃(SoftwareProjectPlan—.引言編寫目的（闡明編寫軟件計(jì)劃的目的，指出讀者對(duì)象。）項(xiàng)目背景（可包括：（1）項(xiàng)目委托單位'開發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。）定義（列出本文檔中用到的專門術(shù)語的定義和縮略詞的原文。）4.參考資料（可包括：文檔所引用的資料、規(guī)范等；列出資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來源。）二.項(xiàng)目概述工作內(nèi)容（簡(jiǎn)要說明項(xiàng)目的各項(xiàng)主要工作，介紹所開發(fā)軟件的功能性能等.若不編寫可行性研究報(bào)告，則應(yīng)在本節(jié)給出較詳細(xì)的介紹。）條件與限制（闡明為完成項(xiàng)目應(yīng)具備的條件開發(fā)單位已具備的條件以及尚需創(chuàng)造的條件.必要時(shí)還應(yīng)說明用戶及分合同承包者承擔(dān)的工作完成期限及其它條件與限制。）產(chǎn)品（1）程序（列出應(yīng)交付的程序名稱使用的語言及存儲(chǔ)形式。）（2）文檔（列出應(yīng)交付的文檔。）（3）運(yùn)行環(huán)境（應(yīng)包括硬件環(huán)境軟件環(huán)境。）4.服務(wù)（闡明開發(fā)單位可向用戶提供的服務(wù).如人員培訓(xùn)安裝保修維護(hù)和其他運(yùn)行支持。）5.驗(yàn)收標(biāo)準(zhǔn)三.實(shí)施計(jì)劃任務(wù)分解（任務(wù)的劃分及各項(xiàng)任務(wù)的負(fù)責(zé)人。）2.進(jìn)度（按階段完成的項(xiàng)目，用圖表說明開始時(shí)間完成時(shí)間。）3.預(yù)算關(guān)鍵問題（說明可能影響項(xiàng)目的關(guān)鍵問題，如設(shè)備條件技術(shù)難點(diǎn)或其他風(fēng)險(xiǎn)因素，井說明對(duì)策。）四.人員組織及分工五.交付期限六.專題計(jì)劃要點(diǎn)（如測(cè)試計(jì)劃等。）需求規(guī)格說明書(RequirementsSpecification)—.引言.編寫目的（闡明編寫需求說明書的目的，指明讀者對(duì)象。）.項(xiàng)目背景（可包括：（1）項(xiàng)目的委托單位，開發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。）.定義（列出文檔中用到的專門術(shù)語定義和縮寫詞的原文。）.參考資料（可包括：（1）項(xiàng)目開發(fā)計(jì)劃；（2）文檔所引用的資料，標(biāo)準(zhǔn)和規(guī)范。列出這些資料的作者'標(biāo)題、編號(hào)'發(fā)表日期、出版單位或資料來源。）任務(wù)概述目標(biāo)運(yùn)行環(huán)境條件與限制數(shù)據(jù)描述.靜態(tài)數(shù)據(jù).動(dòng)態(tài)數(shù)據(jù)（包括輸入數(shù)據(jù)和輸出數(shù)據(jù)。）.數(shù)據(jù)庫描述（給出使用數(shù)據(jù)庫的名稱和類型。）.數(shù)據(jù)詞典.數(shù)據(jù)采集功能需求功能劃分功能描述性能需求數(shù)據(jù)精確度時(shí)間特性（如響應(yīng)時(shí)間'更新處理時(shí)間'數(shù)據(jù)轉(zhuǎn)化與傳輸時(shí)間、運(yùn)行時(shí)間等。）適應(yīng)性（在操作方式運(yùn)行環(huán)境與其他軟件的接口以及開發(fā)計(jì)劃等發(fā)生變化時(shí)，應(yīng)具有的適應(yīng)能力。）運(yùn)行需求用戶界面（如屏幕格式'報(bào)表格式'菜單格式'輸入輸出時(shí)間等。）硬件接口軟件接口故障處理其他需求（如可使用性、安全保密、可維護(hù)性、可移植性等。）概要設(shè)計(jì)說明書（ArchitecturaIDesignSpecification）—.引言編寫目的（闡明編寫概要設(shè)計(jì)說明書的目的，指明讀者對(duì)象。）項(xiàng)目背景（可包括：（1）項(xiàng)目的委托單位，開發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。）定義（列出文檔中用到的專門術(shù)語定義和縮寫詞的原意。）4.參考資料（列出這些資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來源，可包括：（1）項(xiàng)目開發(fā)計(jì)劃；（2）需求規(guī)格說明書；（3）測(cè)試計(jì)劃（初稿）；（4）用戶操作手冊(cè)（初稿）；（5）文檔所引用的資料、采用的標(biāo)準(zhǔn)或規(guī)范。）任務(wù)概述目標(biāo)運(yùn)行環(huán)境3.需求概述條件與限制三.總體設(shè)計(jì).處理流程.總體結(jié)構(gòu)和模塊外部設(shè)計(jì).功能分配（表明各項(xiàng)功能與程序結(jié)構(gòu)的關(guān)系。）接口設(shè)計(jì)外部接口（包括用戶界面軟件接口與硬件接口。）2.內(nèi)部接口（模塊之間的接口。）數(shù)據(jù)結(jié)構(gòu)設(shè)計(jì).邏輯結(jié)構(gòu)設(shè)計(jì).物理結(jié)構(gòu)設(shè)計(jì).數(shù)據(jù)結(jié)構(gòu)與程序的關(guān)系六.運(yùn)行設(shè)計(jì)運(yùn)行模塊的組合運(yùn)行控制運(yùn)行時(shí)間七.出錯(cuò)處理設(shè)計(jì)出錯(cuò)輸出信息出錯(cuò)處理對(duì)策（如設(shè)置后備、性能降級(jí)、恢復(fù)及再啟動(dòng)等。）八.安全保密設(shè)計(jì)九.維護(hù)設(shè)計(jì)

（說明為方便維護(hù)工作的設(shè)施，如維護(hù)模塊等。）詳細(xì)設(shè)計(jì)說明書(ProceduraIDesignSpecification)—.引言（說明為方便維護(hù)工作的設(shè)施，如維護(hù)模塊等。）.編寫目的（闡明編寫詳細(xì)設(shè)計(jì)說明書的目的，指明讀者對(duì)象。）.項(xiàng)目背景（應(yīng)包括項(xiàng)目的來源和主管部門等。）.定義（列出文檔中用到的專門術(shù)語定義和縮寫詞的原意。）.參考資料（列出這些資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來源，可包括：（1）項(xiàng)目開發(fā)計(jì)劃；（2）需求規(guī)格說明書；（3）概要設(shè)計(jì)說明書；（4）測(cè)試計(jì)劃（初稿）;（5）用戶操作手冊(cè)（初稿）；（5）文檔所引用的其他資料'軟件開發(fā)標(biāo)準(zhǔn)或規(guī)范。）總體設(shè)計(jì).需求概述2,軟件結(jié)構(gòu)（如給出軟件系統(tǒng)的結(jié)果圖。）三.程序描述（逐個(gè)模塊給出以下的說明：：）功能性能輸入項(xiàng)目輸出項(xiàng)目5.算法（模塊所選用的算法。）6.程序邏輯（詳細(xì)描述模塊實(shí)現(xiàn)的算法，可采用：：（1）標(biāo)準(zhǔn)流程圖；（2）N-S圖；（3）PAD；（4）判定表等描述算法的圖表。）7.接口8,存儲(chǔ)分配9.限制條件10.測(cè)試要點(diǎn)（給出測(cè)試模塊的主要測(cè)試要求。）用戶操作手冊(cè)（UserGuide）—.引言編寫目的（闡明編寫手冊(cè)的目的，指明讀者對(duì)象。）2.項(xiàng)目背景（說明項(xiàng)目的來源'委托單位、開發(fā)單位及主管部門。）3.定義（列出手冊(cè)中用到的專門術(shù)語定義和縮寫詞的原意。）4.參考資料（列出這些資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來源，可包括：（1）項(xiàng)目開發(fā)計(jì)劃；（2）需求規(guī)格說明書；（3）概要設(shè)計(jì)說明書；（4）詳細(xì)設(shè)計(jì)說明書；（5）測(cè)試計(jì)劃；（6）手冊(cè)中引用的其他資料'采用的軟件工程標(biāo)準(zhǔn)或軟件工程規(guī)范。）二.軟件概述目標(biāo)功能性能1）數(shù)據(jù)精確度（包括輸入、輸出及處理數(shù)據(jù)的精度。）2）時(shí)間特性（如響應(yīng)時(shí)間、處理時(shí)間、數(shù)據(jù)傳輸時(shí)間等。）3）靈活性（在操作方式、運(yùn)行環(huán)境需做某些變更時(shí)軟件的適應(yīng)能力。）運(yùn)行環(huán)境硬件（列出軟件系統(tǒng)運(yùn)行時(shí)所需的硬件最小配置，如：（1）計(jì)算機(jī)型號(hào)'主存容量；（2）外存儲(chǔ)器、媒體、記錄格式'設(shè)備型號(hào)及數(shù)量；（3）輸入、輸出設(shè)備；（4）數(shù)據(jù)傳輸設(shè)備及數(shù)據(jù)轉(zhuǎn)換設(shè)備的型號(hào)及數(shù)量。）支持軟件（如：（1）操作系統(tǒng)名稱及版本號(hào)；（2）語言編譯系統(tǒng)或匯編系統(tǒng)的名稱及版本號(hào)；（3）數(shù)據(jù)庫管理系統(tǒng)的名稱及版本號(hào)；（4）其他必要的支持軟件。）四.使用說明安裝和初始化（給出程序的存儲(chǔ)形式'操作命令'反饋信息及其含義'表明安裝完成的測(cè)試實(shí)例以及安裝所需的軟件工具等。）輸入（給出輸入數(shù)據(jù)或參數(shù)的要求。）1）數(shù)據(jù)背景（說明數(shù)據(jù)來源'存儲(chǔ)媒體、出現(xiàn)頻度、限制和質(zhì)量管理等。））數(shù)據(jù)格式（如：（1）長(zhǎng)度（2）格式基準(zhǔn)（3）標(biāo)號(hào)（4）順序（5）分隔符（6）詞匯表（7）省略和重復(fù)（8）控制。）3）輸入舉例.輸出（給出每項(xiàng)輸出數(shù)據(jù)的說明。）1）數(shù)據(jù)背景（說明輸出數(shù)據(jù)的去向、使用頻度、存放媒體及質(zhì)量管理等。）2）數(shù)據(jù)格式（詳細(xì)闡明每一輸出數(shù)據(jù)的格式，如：首部主體和尾部的具體形式。）3）舉例出錯(cuò)和恢復(fù)（給出：（1）出錯(cuò)信息及其含義（2）用戶應(yīng)采取的措施，如修改、恢復(fù)、再啟動(dòng)。）求助查詢（說明如何操作。）運(yùn)行說明運(yùn)行表[列出每種可能的運(yùn)行情況，說明其運(yùn)行目的.]運(yùn)行步驟[按順序說明每種運(yùn)行的步驟，應(yīng)包括:]（1）運(yùn)行控制（2）操作信息（（1）運(yùn)行目的（2）操作要求（3）啟動(dòng)方法（4）預(yù)計(jì)運(yùn)行時(shí)間（5）操作命令格式及說明（6）其他事項(xiàng)。）（3）輸入/輸出文件（給出建立和更新文件的有關(guān)信息，如：（1）文件的名稱及編號(hào)（2）記錄媒體（3）存留的目錄（4）文件的支配（說明確定保留文件或廢棄文件的準(zhǔn)則，分發(fā)文件的對(duì)象，占用硬件的優(yōu)先級(jí)及保密控制等。）（4）啟動(dòng)或恢復(fù)過程非常規(guī)過程（提供應(yīng)急或非常規(guī)操作的必要信息及操作步驟，如出錯(cuò)處理操作、向后備系統(tǒng)切換操作以及維護(hù)人員須知的操作和注意事項(xiàng)。）操作命令一覽表（按字母順序逐個(gè)列出全部操作命令的格式功能及參數(shù)說明。）八.程序文件（或命令文件）和數(shù)據(jù)文件一覽表（按文件名字母順序或按功能與模塊分類順序逐個(gè)列出文件名稱'標(biāo)識(shí)符及說明。）九.用戶操作舉例測(cè)試計(jì)劃（TestPlan）—、引言.編寫目的（闡明編寫測(cè)試計(jì)劃的目的，指明讀者對(duì)象。）.項(xiàng)目背景（說明項(xiàng)目的來源委托單位及主管部門。）.定義（列出測(cè)試計(jì)劃中用到的專門術(shù)語定義和縮寫詞的原意。）.參考資料（列出這些資料的作者、標(biāo)題、編號(hào)'發(fā)表日期、出版單位或資料來源，可包括：（1）項(xiàng)目開發(fā)計(jì)劃；（2）需求規(guī)格說明書；（3）概要設(shè)計(jì)說明書；（4）詳細(xì)設(shè)計(jì)說明書；（5）用戶操作手冊(cè)；（6）本測(cè)試計(jì)劃中引用的其他資料采用的軟件開發(fā)標(biāo)準(zhǔn)或規(guī)范。）任務(wù)概述目標(biāo)運(yùn)行環(huán)境3.需求概述4.條件與限制計(jì)劃.測(cè)試方案（說明確定測(cè)試方法和選取測(cè)試用例的原則。）.測(cè)試項(xiàng)目（列出組裝測(cè)試和確認(rèn)測(cè)試中每一項(xiàng)測(cè)試的內(nèi)容、名稱、目的和進(jìn)度。）.測(cè)試準(zhǔn)備.測(cè)試機(jī)構(gòu)及人員（測(cè)試機(jī)構(gòu)名稱負(fù)責(zé)人和職責(zé)。）四.測(cè)試項(xiàng)目說明（按順序逐個(gè)對(duì)測(cè)試項(xiàng)目做出說明：）.測(cè)試項(xiàng)目名稱及測(cè)試內(nèi)容.測(cè)試用例1）輸入（輸入的數(shù)據(jù)和輸入的命令。）2）輸出（預(yù)期的輸出數(shù)據(jù)。）（3）步驟及操作（4）允許偏差（給出實(shí)測(cè)結(jié)果與預(yù)測(cè)結(jié)果之間允許偏差的范圍。）.進(jìn)度.條件（給出項(xiàng)測(cè)試對(duì)資源的特殊要求，如設(shè)備、軟件、人員等。）.測(cè)試資料（說明項(xiàng)測(cè)試所需的資料。）五.評(píng)價(jià)范圍（說明所完成的各項(xiàng)測(cè)試說明問題的范圍及其局限性。）準(zhǔn)則（說明評(píng)價(jià)測(cè)試結(jié)果的準(zhǔn)則。）測(cè)試分析報(bào)告（TestSpecification）—.引言1.編寫目的（闡明編寫測(cè)試分析報(bào)告的目的，指明讀者對(duì)象。）2.項(xiàng)目背景（說明項(xiàng)目的來源、委托單位及主管部門。）3.定義（列出測(cè)試分析報(bào)告中用到的專門術(shù)語定義和縮寫詞的原意。）4.參考資料（列出這些資料的作者、標(biāo)題、編號(hào)'發(fā)表日期、出版單位或資料來源，可包括：（1）項(xiàng)目開發(fā)計(jì)劃；（2）需求規(guī)格說明書；（3）概要設(shè)計(jì)說明書；（4）詳細(xì)設(shè)計(jì)說明書；（5）用戶操作手冊(cè)；（6）測(cè)試計(jì)劃；（7）測(cè)試分析報(bào)告所引用的其他資料、采用的軟件工程標(biāo)準(zhǔn)或軟件工程規(guī)范。）測(cè)試計(jì)劃執(zhí)行情況1.測(cè)試項(xiàng)目（列出每一測(cè)試項(xiàng)目的名稱、內(nèi)容和目的。）2.測(cè)試機(jī)構(gòu)和人員（給出測(cè)試機(jī)構(gòu)名稱、負(fù)責(zé)人和參與測(cè)試人員名單。）3.測(cè)試結(jié)果（按順序給出每一測(cè)試項(xiàng)目的：（1）實(shí)測(cè)結(jié)果數(shù)據(jù)（2）與預(yù)期結(jié)果數(shù)據(jù)的偏差（3）該項(xiàng)測(cè)試說明的事實(shí)（4）該項(xiàng)測(cè)試發(fā)現(xiàn)的問題。）軟件需求測(cè)試結(jié)論（按順序給出每一項(xiàng)需求測(cè)試的結(jié)論。包括：（1）證實(shí)的軟件能力（2）局限性（即項(xiàng)需求未得到充分測(cè)試的情況及原因）。）評(píng)價(jià)1.軟