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

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

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

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

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

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