技術(shù)報告編寫規(guī)范及項目技術(shù)報告

精品文檔精心整理精品文檔可編輯的精品文檔精品文檔精心整理精品文檔可編輯的精品文檔技術(shù)報告編寫規(guī)范文件編號：NW506102生效日期：2000.3.20受控編號：密級：秘密版次：Ver2.1修改狀態(tài)：總頁數(shù)8正文4附錄4編制：孟莉?qū)徍耍涸磁鷾?zhǔn)：孟莉沈陽東大阿爾派軟件股份有限公司（，翻版必究）文件修改控制修改記錄編號修改狀態(tài)修改頁碼及條款修改人審核人批準(zhǔn)人修改日期目錄1.目的2.適用范圍3.術(shù)語及縮略語4.編寫規(guī)范4.1排版規(guī)范4.2模板使用5.引用文件6.附錄目的技術(shù)報告編寫規(guī)范主要描述在軟件產(chǎn)品或軟件項目開發(fā)完成時所需編寫的技術(shù)報告應(yīng)該包含的內(nèi)容，使得本公司編寫的技術(shù)報告便于軟件產(chǎn)品或軟件項目日后的維護(hù)、交接和代碼重用。適用范圍適用于本公司軟件產(chǎn)品或軟件項目的技術(shù)報告的編寫。術(shù)語及縮略語本程序采用NQ402100《質(zhì)量手冊》中的術(shù)語和縮略語及其定義。編寫規(guī)范排版規(guī)范整個規(guī)范由2節(jié)構(gòu)成，模板單獨(dú)一節(jié)。正文樣式采用“規(guī)范正文”。標(biāo)題編號采用每節(jié)獨(dú)立編號。模板使用拷貝規(guī)范。刪除第一節(jié)（技術(shù)報告封面前的所有頁）。在修改完內(nèi)容后，更新目錄域和相關(guān)的頁數(shù)域。引用文件(無)附錄以下部分為技術(shù)報告的模板。密級：文檔編號：第版分冊名稱：第冊/共冊項目名稱（項目編號）技術(shù)報告（部門名稱）沈陽東大阿爾派軟件股份有限公司總頁數(shù)正文附錄生效日期：年月日編制：審核：批準(zhǔn)：目錄1.引言31.1目的31.2背景31.3術(shù)語31.4人員31.5參考資料32.系統(tǒng)概述32.1適用范圍及系統(tǒng)特性簡要說明32.2子系統(tǒng)及其模塊的劃分32.3系統(tǒng)運(yùn)行環(huán)境33.文件一覽43.1系統(tǒng)運(yùn)行文件一覽43.2源程序文件一覽43.3函數(shù)、類、事件一覽（可選）44.數(shù)據(jù)庫結(jié)構(gòu)45.可重用子系統(tǒng)或模塊46.總結(jié)與展望4引言目的說明編寫本《技術(shù)報告》的目的。背景說明理解本報告所需的背景，如與公司其它軟件之間的聯(lián)系等。術(shù)語列出本報告中專門術(shù)語的定義和英文縮寫詞的原詞組。人員給出本軟件的開發(fā)人員。姓名部門職務(wù)或角色電話參考資料：列出編寫參考的文件、資料、技術(shù)標(biāo)準(zhǔn)以及他們的作者、標(biāo)題、編號、發(fā)布日期和出版單位。編號資料名稱簡介作者日期出版單位列出編寫本報告時需查閱的Intenet上雜志、專業(yè)著作、技術(shù)標(biāo)準(zhǔn)以及他們的網(wǎng)址。網(wǎng)點(diǎn)簡介系統(tǒng)概述適用范圍及系統(tǒng)特性簡要說明簡述本軟件系統(tǒng)適用的領(lǐng)域、功能要點(diǎn)、產(chǎn)品化程度。子系統(tǒng)及其模塊的劃分給出系統(tǒng)中各個子系統(tǒng)及其模塊簡要的功能描述，并用圖形的方式給出各個子系統(tǒng)及其模塊之間的關(guān)系。如果本軟件系統(tǒng)是一個更大的系統(tǒng)的一個組成部分，則還要說明本軟件系統(tǒng)與這個更大的系統(tǒng)中的其他各組成部分之間的關(guān)系。系統(tǒng)運(yùn)行環(huán)境給出本軟件系統(tǒng)運(yùn)行所需的基本軟/硬件環(huán)境、使用本軟件系統(tǒng)典型用戶的設(shè)備分布圖及設(shè)備上相應(yīng)軟件配置。軟件環(huán)境包括：操作系統(tǒng)、數(shù)據(jù)庫、以及其它支撐軟件；硬件環(huán)境包括：主機(jī)類型、網(wǎng)絡(luò)類型、存儲器容量、其它特殊設(shè)備。如有同等作用的內(nèi)容或文件（如已編寫的《系統(tǒng)設(shè)計報告》）則可直接在此引述該文件名及歸檔的部門即可。文件一覽系統(tǒng)運(yùn)行文件一覽給出本軟件系統(tǒng)(或分別給出各子系統(tǒng))運(yùn)行時其各種文件系統(tǒng)目錄、文件一覽表，并說明其意義、內(nèi)容等。源程序文件一覽給出本軟件系統(tǒng)(或分別給出各子系統(tǒng))源程序文件及頭文件目錄、文件一覽表，并簡要說明各源程序文件所包含的內(nèi)容、與子系統(tǒng)及其模塊的對應(yīng)關(guān)系。函數(shù)、類、事件一覽（可選）按照源程序文件一覽的順序，給出源程序文件中函數(shù)、類、事件的說明。具體要求如下：函數(shù)的功能：必要時簡要給出算法；函數(shù)調(diào)用參數(shù)及返回值：說明各參數(shù)及返回值的作用、意義及其取值范圍。數(shù)據(jù)庫結(jié)構(gòu)對于MIS等使用數(shù)據(jù)庫的項目，必須詳細(xì)說明數(shù)據(jù)庫中各數(shù)據(jù)庫表之間的關(guān)系，詳細(xì)說明各數(shù)據(jù)庫表中每一個字段的作用、意義及其取值范圍。如果其取值范圍是可枚舉的，應(yīng)說明每一取值的含義。如有同等作用的內(nèi)容或文件（如已編寫的《系統(tǒng)設(shè)計報告》）則可直接在此引述該文件名及歸檔的部門即可?？芍赜米酉到y(tǒng)或模塊以列表的方式給出本軟件系統(tǒng)中可被其它系