技術(shù)報(bào)告編寫規(guī)范及項(xiàng)目技術(shù)報(bào)告(doc 8頁(yè))

1、技術(shù)報(bào)告編寫規(guī)范文件編號(hào)： NW506102 生效日期： 2000.3.20受控編號(hào)：密級(jí)：秘密版次：Ver2.1修改狀態(tài)：總頁(yè)數(shù)8正文4附錄4編制：孟莉?qū)徍耍涸磁鷾?zhǔn)：孟莉沈陽(yáng)東大阿爾派軟件股份有限公司（所有,翻版必究）文件修改控制修改記錄編號(hào)修改狀態(tài)修改頁(yè)碼及條款修改人審核人批準(zhǔn)人修改日期目錄1. 目的2. 適用范圍3. 術(shù)語(yǔ)及縮略語(yǔ)4. 編寫規(guī)范4.1 排版規(guī)范4.2 模板使用5. 引用文件6. 附錄1. 目的技術(shù)報(bào)告編寫規(guī)范主要描述在軟件產(chǎn)品或軟件項(xiàng)目開(kāi)發(fā)完成時(shí)所需編寫的技術(shù)報(bào)告應(yīng)該包含的內(nèi)容,使得本公司編寫的技術(shù)報(bào)告便于軟件產(chǎn)品或軟件項(xiàng)目日后的維護(hù)、交接和代碼重用。2. 適用范圍適用

2、于本公司軟件產(chǎn)品或軟件項(xiàng)目的技術(shù)報(bào)告的編寫。3. 術(shù)語(yǔ)及縮略語(yǔ)本程序采用NQ402100質(zhì)量手冊(cè)中的術(shù)語(yǔ)和縮略語(yǔ)及其定義。4. 編寫規(guī)范4.1 排版規(guī)范1） 整個(gè)規(guī)范由2節(jié)組成,模板單獨(dú)一節(jié)。2） 正文樣式采用“規(guī)范正文”。3） 標(biāo)題編號(hào)采用每節(jié)獨(dú)立編號(hào)。4.2 模板使用1） 拷貝規(guī)范。2） 刪除第一節(jié)（技術(shù)報(bào)告封面前的所有頁(yè)）。3） 在修改完內(nèi)容后,更新目錄域和相關(guān)的頁(yè)數(shù)域。5. 引用文件(無(wú))6. 附錄以下部分為技術(shù)報(bào)告的模板。5 / 9密級(jí)：文檔編號(hào)：第 版分冊(cè)名稱：第 冊(cè)/共 冊(cè)項(xiàng)目名稱（項(xiàng)目編號(hào)）技術(shù)報(bào)告（部門名稱）沈陽(yáng)東大阿爾派軟件股份有限公司總頁(yè)數(shù)正文附錄生效日期： 年 月 日編

3、制：審核：批準(zhǔn)：目錄1. 引言1.1 目的1.2 背景1.3 術(shù)語(yǔ)1.4 人員1.5 參考資料2. 系統(tǒng)概述2.1 適用范圍及系統(tǒng)特性簡(jiǎn)要說(shuō)明2.2 子系統(tǒng)及其模塊的劃分2.3 系統(tǒng)運(yùn)行環(huán)境3. 文件一覽3.1 系統(tǒng)運(yùn)行文件一覽3.2 源程序文件一覽3.3 函數(shù)、類、事件一覽（可選）4. 數(shù)據(jù)庫(kù)結(jié)構(gòu)5. 可重用子系統(tǒng)或模塊6. 總結(jié)與展望1. 引言1.1 目的說(shuō)明編寫本技術(shù)報(bào)告的目的。1.2 背景說(shuō)明理解本報(bào)告所需的背景,如與公司其它軟件之間的聯(lián)系等。1.3 術(shù)語(yǔ)列出本報(bào)告中專門術(shù)語(yǔ)的定義和英文縮寫詞的原詞組。1.4 人員給出本軟件的開(kāi)發(fā)人員。姓名部門職務(wù)或角色電話1.5 參考資料：列出編寫參

4、考的文件、資料、技術(shù)標(biāo)準(zhǔn)以及他們的作者、標(biāo)題、編號(hào)、發(fā)布日期和出版單位。編號(hào)資料名稱簡(jiǎn)介作者日期出版單位列出編寫本報(bào)告時(shí)需查閱的Intenet上雜志、專業(yè)著作、技術(shù)標(biāo)準(zhǔn)以及他們的網(wǎng)址。網(wǎng)點(diǎn)簡(jiǎn)介2. 系統(tǒng)概述2.1 適用范圍及系統(tǒng)特性簡(jiǎn)要說(shuō)明簡(jiǎn)述本軟件系統(tǒng)適用的領(lǐng)域、效用要點(diǎn)、產(chǎn)品化程度。2.2 子系統(tǒng)及其模塊的劃分給出系統(tǒng)中各個(gè)子系統(tǒng)及其模塊簡(jiǎn)要的效用描述,并用圖形的方式給出各個(gè)子系統(tǒng)及其模塊之間的關(guān)系。如果本軟件系統(tǒng)是一個(gè)更大的系統(tǒng)的一個(gè)組成部分,則還要說(shuō)明本軟件系統(tǒng)與這個(gè)更大的系統(tǒng)中的其他各組成部分之間的關(guān)系。2.3 系統(tǒng)運(yùn)行環(huán)境給出本軟件系統(tǒng)運(yùn)行所需的基本軟/硬件環(huán)境、使用本軟件系統(tǒng)典型

5、用戶的設(shè)備分布圖及設(shè)備上相應(yīng)軟件配置。軟件環(huán)境包括：操作系統(tǒng)、數(shù)據(jù)庫(kù)、以及其它支撐軟件；硬件環(huán)境包括：主機(jī)類型、網(wǎng)絡(luò)類型、存儲(chǔ)器容量、其它特殊設(shè)備。如有同等作用的內(nèi)容或文件（如已編寫的系統(tǒng)設(shè)計(jì)報(bào)告）則可直接在此引述該文件名及歸檔的部門即可。3. 文件一覽3.1 系統(tǒng)運(yùn)行文件一覽給出本軟件系統(tǒng)(或分別給出各子系統(tǒng))運(yùn)行時(shí)其各種文件系統(tǒng)目錄、文件一覽表,并說(shuō)明其意義、內(nèi)容等。3.2 源程序文件一覽給出本軟件系統(tǒng)(或分別給出各子系統(tǒng))源程序文件及頭文件目錄、文件一覽表,并簡(jiǎn)要說(shuō)明各源程序文件所包含的內(nèi)容、與子系統(tǒng)及其模塊的對(duì)應(yīng)關(guān)系。3.3 函數(shù)、類、事件一覽（可選）按照源程序文件一覽的順序,給出源程序文件中函數(shù)、類、事件的說(shuō)明。具體要求如下：1) 函數(shù)的效用：必要時(shí)簡(jiǎn)要給出算法；2) 函數(shù)調(diào)用參數(shù)及返回值：說(shuō)明各參數(shù)及返回值的作用、意義及其取值范圍。4. 數(shù)據(jù)庫(kù)結(jié)構(gòu)對(duì)于MIS等使用數(shù)據(jù)庫(kù)的項(xiàng)目,必須詳細(xì)說(shuō)明數(shù)據(jù)庫(kù)中各數(shù)據(jù)庫(kù)表之間的關(guān)系,詳細(xì)說(shuō)明各數(shù)據(jù)庫(kù)表中每一個(gè)字段的作用、意義及其取值范圍。如果其取值范圍是可枚舉的,應(yīng)說(shuō)明每一取值的含義。如有同等作用的內(nèi)容或文件（如已編寫的系統(tǒng)設(shè)計(jì)報(bào)告）則可直接在此引述該文件名及歸檔的部門即可。5. 可重用子系統(tǒng)或模塊以列表的方式給出本軟件系統(tǒng)中可被其它系統(tǒng)應(yīng)用的子