（技術(shù)規(guī)范標準）技術(shù)報告編寫規(guī)范

技術(shù)報告編寫規(guī)范技術(shù)報告編寫規(guī)范 (技術(shù)規(guī)范標準)技術(shù)報告編寫規(guī)范技術(shù)報告編寫規(guī)范技術(shù)報告編寫規(guī)范技術(shù)報告編寫規(guī)范2.適用范圍3.術(shù)語及縮略語4.編寫規(guī)范4.1排版規(guī)范4.2模板使用6.附錄1.目的技術(shù)報告編寫規(guī)范主要描述在軟件產(chǎn)品或軟件項目開發(fā)完成時所需編寫的技術(shù)報告應(yīng)該包含的內(nèi)容，使得本公司編寫的技術(shù)報告便于軟件產(chǎn)品或軟件項目日后的維護、交接和代碼重用。2.適用范圍適用于本公司軟件產(chǎn)品或軟件項目的技術(shù)報告的編寫。3.術(shù)語及縮略語4.編寫規(guī)范1)整個規(guī)范由2節(jié)構(gòu)成，模板單獨一節(jié)。2)正文樣式采用“規(guī)范正文”。3)標題編號采用每節(jié)獨立編號。2)刪除第一節(jié)(技術(shù)報告封面前的所有頁)。5.引用文件(無)6.附錄告的模板。技術(shù)報告密1/4：第冊/共冊項目名稱(項目編號) (部門名稱)批準：目的3背景3術(shù)語3人員3參考資料32.1適用范圍及系統(tǒng)特性簡要說明32.2子系統(tǒng)及其模塊的劃分32.3系統(tǒng)運行環(huán)境3系統(tǒng)運行文件一覽4源程序文件一覽43.3函數(shù)、類、事件一覽(可選)44.數(shù)據(jù)庫結(jié)構(gòu)45.可重用子系統(tǒng)或模塊4技術(shù)報告2/41.引言說明編寫本《技術(shù)報告》的目的。說明理解本報告所需的背景，如與公司其它軟件之間的聯(lián)系等。列出本報告中專門術(shù)語的定義和英文縮寫詞的原詞組。給出本軟件的開發(fā)人員。列出編寫參考的文件、資料、技術(shù)標準以及他們的作者、標題、編號、發(fā)布址。2.系統(tǒng)概述明領(lǐng)域、功能要點、產(chǎn)品化程度。給出系統(tǒng)中各個子系統(tǒng)及其模塊簡要的功能描述，并用圖形的方式給出各個子系統(tǒng)及其模塊之間的關(guān)系。如果本軟件系統(tǒng)是一個更大的系統(tǒng)的一個組成部分，則還要說明本軟件系統(tǒng)與這個更大的系統(tǒng)中的其他各組成部分之間的關(guān)系。備分布圖及設(shè)備上相應(yīng)軟件配置。軟件環(huán)境包括：操作系統(tǒng)、數(shù)據(jù)庫、以及其它支撐軟件；硬件環(huán)境包括：主機類型、網(wǎng)絡(luò)類型、存儲器容量、其它特殊設(shè)備。如有同等作用的內(nèi)容或文件(如已編寫的《系統(tǒng)設(shè)計報告》)則可直接在此引述該文件名及歸檔的部門即可。3.文件一覽給出本軟件系統(tǒng)(或分別給出各子系統(tǒng))運行時其各種文件系統(tǒng)目錄、文件一技術(shù)報告3/4給出本軟件系統(tǒng)(或分別給出各子系統(tǒng))源程序文件及頭文件目錄、文件一覽3.3函數(shù)、類、事件一覽(可選)順序，給出源程序文件中函數(shù)、類、事件的說明。具體要求如下：給出算法；2)函數(shù)調(diào)用參數(shù)及返回值：說明各參數(shù)及返回值的作用、意義及其取值范4.數(shù)據(jù)庫結(jié)構(gòu)系，詳細說明各數(shù)據(jù)庫表中每一個字段的作用、意義及其取值范圍。如果其取值范圍是可枚舉的，應(yīng)說明每一取值的含義。如有同等作用的內(nèi)容或文件 (如已編寫的《系統(tǒng)設(shè)計報告》)則可直接在此引述該文件名及歸檔的部門即可。5.可重用子系統(tǒng)或模塊的方式給出本軟件系統(tǒng)中可被其它系統(tǒng)應(yīng)用的子系統(tǒng)或模塊，說明這些可重用子系統(tǒng)或模塊