技術(shù)報(bào)告編寫(xiě)規(guī)范
技術(shù)報(bào)告編寫(xiě)規(guī)范 |文件編號(hào)： |生效日期： |受控編號(hào)： | |NW506102 |2000.3.20 | | |密級(jí)：秘密 |版次：Ver2.1 |修改狀態(tài)： | |總頁(yè)數(shù) |8 |正文 |4 |附錄 |4 | |編制：孟莉 |審核：袁淮 |批準(zhǔn)：孟莉 | 沈陽(yáng)東大阿爾派軟件股份有限公司 （版權(quán)所有，翻版必究） 文件修改控制 |修改記錄編號(hào) |修改 |修改頁(yè)碼及條款 |修改人|審核人|批準(zhǔn)人|修改日期 | | |狀態(tài) | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 目錄 1. 目的 2. 適用范圍 3. 術(shù)語(yǔ)及縮略語(yǔ) 4. 編寫(xiě)規(guī)范 4.1 排版規(guī)范 4.2 模板使用 5. 引用文件 6. 附錄 目的 技術(shù)報(bào)告編寫(xiě)規(guī)范主要描述在軟件產(chǎn)品或軟件項(xiàng)目開(kāi)發(fā)完成時(shí)所需編寫(xiě)的技術(shù)報(bào)告應(yīng) 該包含的內(nèi)容，使得本公司編寫(xiě)的技術(shù)報(bào)告便于軟件產(chǎn)品或軟件項(xiàng)目日后的維護(hù)、交 接和代碼重用。 適用范圍 適用于本公司軟件產(chǎn)品或軟件項(xiàng)目的技術(shù)報(bào)告的編寫(xiě)。 術(shù)語(yǔ)及縮略語(yǔ) 本程序采用NQ402100《質(zhì)量手冊(cè)》中的術(shù)語(yǔ)和縮略語(yǔ)及其定義。 編寫(xiě)規(guī)范 4.1 排版規(guī)范 1. 整個(gè)規(guī)范由2節(jié)構(gòu)成，模板單獨(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ù)域。 引用文件 (無(wú)) 附錄 以下部分為技術(shù)報(bào)告的模板。 密級(jí)：機(jī)密 文檔編號(hào)： 第 版 分冊(cè)名稱： 第 冊(cè)/共 冊(cè) 項(xiàng)目名稱（項(xiàng)目編號(hào)） 技術(shù)報(bào)告 （部門名稱） 沈陽(yáng)東大阿爾派軟件股份有限公司 |總頁(yè)數(shù)| |正文 | |附錄 | |生效日期： 年 月 日| |編制： |審核： |批準(zhǔn)： | 目錄 1. 引言 3 1.1 目的 3 1.2 背景 3 1.3 術(shù)語(yǔ) 3 1.4 人員 3 1.5 參考資料 3 2. 系統(tǒng)概述 3 2.1 適用范圍及系統(tǒng)特性簡(jiǎn)要說(shuō)明 3 2.2 子系統(tǒng)及其模塊的劃分 3 2.3 系統(tǒng)運(yùn)行環(huán)境 3 3. 文件一覽 4 3.1 系統(tǒng)運(yùn)行文件一覽 4 3.2 源程序文件一覽 4 3.3 函數(shù)、類、事件一覽（可選） 4 4. 數(shù)據(jù)庫(kù)結(jié)構(gòu) 4 5. 可重用子系統(tǒng)或模塊 4 6. 總結(jié)與展望 4 引言 7.1 目的 說(shuō)明編寫(xiě)本《技術(shù)報(bào)告》的目的。 7.2 背景 說(shuō)明理解本報(bào)告所需的背景，如與公司其它軟件之間的聯(lián)系等。 7.3 術(shù)語(yǔ) 列出本報(bào)告中專門術(shù)語(yǔ)的定義和英文縮寫(xiě)詞的原詞組。 7.4 人員 給出本軟件的開(kāi)發(fā)人員。 |姓名 |部門 |職務(wù)或角色 |電話 | | | | | | 7.5 參考資料： 列出編寫(xiě)參考的文件、資料、技術(shù)標(biāo)準(zhǔn)以及他們的作者、標(biāo)題、編號(hào)、發(fā)布日期和出 版單位。 |編號(hào) |資料名稱 |簡(jiǎn)介 |作者 |日期 |出版單位 | | | | | | | | 列出編寫(xiě)本報(bào)告時(shí)需查閱的Intenet上雜志、專業(yè)著作、技術(shù)標(biāo)準(zhǔn)以及他們的網(wǎng)址。 |網(wǎng)點(diǎn) |簡(jiǎn)介 | | | | 系統(tǒng)概述 8.1 適用范圍及系統(tǒng)特性簡(jiǎn)要說(shuō)明 簡(jiǎn)述本軟件系統(tǒng)適用的領(lǐng)域、功能要點(diǎn)、產(chǎn)品化程度。 8.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)系。 8.3 系統(tǒng)運(yùn)行環(huán)境 給出本軟件系統(tǒng)運(yùn)行所需的基本軟/硬件環(huán)境、使用本軟件系統(tǒng)典型用戶的設(shè)備分布 圖及設(shè)備上相應(yīng)軟件配置。軟件環(huán)境包括：操作系統(tǒng)、數(shù)據(jù)庫(kù)、以及其它支撐軟件； 硬件環(huán)境包括：主機(jī)類型、網(wǎng)絡(luò)類型、存儲(chǔ)器容量、其它特殊設(shè)備。如有同等作用的 內(nèi)容或文件（如已編寫(xiě)的《系統(tǒng)設(shè)計(jì)報(bào)告》）則可直接在此引述該文件名及歸檔的部門 即可。 文件一覽 9.1 系統(tǒng)運(yùn)行文件一覽 給出本軟件系統(tǒng)(或分別給出各子系統(tǒng))運(yùn)行時(shí)其各種文件系統(tǒng)目錄、文件一覽表，并 說(shuō)明其意義、內(nèi)容等。 9.2 源程序文件一覽 給出本軟件系統(tǒng)(或分別給出各子系統(tǒng))源程序文件及頭文件目錄、文件一覽表，并簡(jiǎn) 要說(shuō)明各源程序文件所包含的內(nèi)容、與子系統(tǒng)及其模塊的對(duì)應(yīng)關(guān)系。 9.3 函數(shù)、類、事件一覽（可選） 按照源程序文件一覽的順序，給出源程序文件中函數(shù)、類、事件的說(shuō)明。具體要求如 下： 1) 函數(shù)的功能：必要時(shí)簡(jiǎn)要給出算法； 2) 函數(shù)調(diào)用參數(shù)及返回值：說(shuō)明各參數(shù)及返回值的作用、意義及其取值范圍。 數(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)容或文件（如已編寫(xiě)的《系統(tǒng)設(shè)計(jì)報(bào) 告》）則可直接在此引述該文件名及歸檔的部門即可。 可重用子系統(tǒng)或模塊 以列表的方式給出本軟件系統(tǒng)中可被其它系統(tǒng)應(yīng)用的子系統(tǒng)或模塊，說(shuō)明這些可重用 子系統(tǒng)或模塊的應(yīng)用范圍。 總結(jié)與展望 說(shuō)明本軟件系統(tǒng)在開(kāi)發(fā)過(guò)程中的經(jīng)驗(yàn)與教訓(xùn)，尚存的功能、可靠性等方面的問(wèn)題，該 軟件系統(tǒng)以后的發(fā)展方向及再開(kāi)發(fā)策略。 ----------------------- [pic] [pic]
技術(shù)報(bào)告編寫(xiě)規(guī)范