軟件開發(fā)文檔規(guī)范

1、附2:軟件文檔編寫向?qū)к浖臋n編寫向?qū)臋n分類文檔分類項目包括如下幾類文檔：項目管理文檔。包括：《軟件項目計劃》、《項目進度報告》、《項目開發(fā)總結(jié)報告》軟件開發(fā)文檔。包括：《需求規(guī)格說明》、《概要設(shè)計說明》、《詳細設(shè)計說明》、《測試計劃》、《軟件測試分析報告》。產(chǎn)品文檔。包括：《用戶操作手冊》《演示文件》。軟件項目計劃軟件項目計劃（SoftwareSoftwareProjectProjectPlanPlan）一引言1編寫目的（闡明編寫軟

2、件計劃的目的，指出讀者對象。）2項目背景（可包括：（1）項目委托單位、開發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。）3定義（列出本文檔中用到的專門術(shù)語的定義和縮略詞的原文。）4參考資料（可包括：文檔所引用的資料、規(guī)范等；列出資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源。）二項目概述1.工作內(nèi)容（簡要說明項目的各項主要工作介紹所開發(fā)軟件的功能性能等.若不編寫可行性研究報告則應(yīng)在本節(jié)給出較詳細的介紹。)2.條件與限制（闡明

3、為完成項目應(yīng)具備的條件開發(fā)單位已具備的條件以及尚需創(chuàng)造的條件.必要時還應(yīng)說明用戶及分合同承包者承擔的工作完成期限及其它條件與限制。）3.產(chǎn)品（1）程序（列出應(yīng)交付的程序名稱使用的語言及存儲形式。）（2）文檔（列出應(yīng)交付的文檔。）（3）運行環(huán)境（應(yīng)包括硬件環(huán)境軟件環(huán)境。）4服務(wù)（闡明開發(fā)單位可向用戶提供的服務(wù).如人員培訓安裝保修維護和其他運行支持。）說明書；（5）用戶操作手冊；（6）測試計劃；（7）測試分析報告（8）本報告引用的其他資料、

4、采用的開發(fā)標準或開發(fā)規(guī)范。）二開發(fā)結(jié)果1產(chǎn)品（可包括：（1）列出各部分的程序名稱、源程序行數(shù)（包括注釋行）或目標程序字節(jié)數(shù)及程序總計數(shù)量、存儲形式；產(chǎn)品文檔名稱等。）2主要功能及性能3所用工時（按人員的不同層次分別計時。）4所用機時5進度（給出計劃進度與實際進度的對比。）三評價1生產(chǎn)率評價（如平均每人每周源程序行數(shù)、文檔的字數(shù)等。）2技術(shù)方案評價3產(chǎn)品質(zhì)量評價四經(jīng)驗與教訓需求規(guī)格說明書需求規(guī)格說明書（RequirementsRequir

5、ementsSpecificationSpecification）一引言1編寫目的（闡明編寫需求說明書的目的指明讀者對象。）2項目背景（可包括：（1）項目的委托單位開發(fā)單位和主管部門；（2）該軟件系統(tǒng)與其他系統(tǒng)的關(guān)系。）3定義（列出文檔中用到的專門術(shù)語定義和縮寫詞的原文。）4參考資料（可包括：（1）項目開發(fā)計劃；（2）文檔所引用的資料，標準和規(guī)范。列出這些資料的作者、標題、編號、發(fā)表日期、出版單位或資料來源。）二任務(wù)概述1目標2運行環(huán)境