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