技術(shù)報告編寫規(guī)范
綜合能力考核表詳細(xì)內(nèi)容
技術(shù)報告編寫規(guī)范
文件修改控制
修改記錄編號 修改
狀態(tài) 修改頁碼及條款 修改人 審核人 批準(zhǔn)人 修改日期
目錄
1. 目的
2. 適用范圍
3. 術(shù)語及縮略語
4. 編寫規(guī)范
4.1 排版規(guī)范
4.2 模板使用
5. 引用文件
6. 附錄
1. 目的
技術(shù)報告編寫規(guī)范主要描述在軟件產(chǎn)品或軟件項目開發(fā)完成時所需編寫的技術(shù)報告應(yīng)該包含的內(nèi)容,使得本公司編寫的技術(shù)報告便于軟件產(chǎn)品或軟件項目日后的維護(hù)、交接和代碼重用。
2. 適用范圍
適用于本公司軟件產(chǎn)品或軟件項目的技術(shù)報告的編寫。
3. 術(shù)語及縮略語
本程序采用NQ402100《質(zhì)量手冊》中的術(shù)語和縮略語及其定義。
4. 編寫規(guī)范
4.1 排版規(guī)范
1) 整個規(guī)范由2節(jié)構(gòu)成,模板單獨一節(jié)。
2) 正文樣式采用“規(guī)范正文”。
3) 標(biāo)題編號采用每節(jié)獨立編號。
4.2 模板使用
1) 拷貝規(guī)范。
2) 刪除第一節(jié)(技術(shù)報告封面前的所有頁)。
3) 在修改完內(nèi)容后,更新目錄域和相關(guān)的頁數(shù)域。
5. 引用文件
(無)
6. 附錄
以下部分為技術(shù)報告的模板。
密級:機(jī)密
文檔編號: 第 版
分冊名稱: 第 冊/共 冊
項目名稱(項目編號)
技術(shù)報告
(部門名稱)
沈陽東大阿爾派軟件股份有限公司
總頁數(shù) 正文 附錄 生效日期: 年 月 日
編制: 審核: 批準(zhǔn):
目錄
1. 引言 3
1.1 目的 3
1.2 背景 3
1.3 術(shù)語 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é)構(gòu) 4
5. 可重用子系統(tǒng)或模塊 4
6. 總結(jié)與展望 4
1. 引言
1.1 目的
說明編寫本《技術(shù)報告》的目的。
1.2 背景
說明理解本報告所需的背景,如與公司其它軟件之間的聯(lián)系等。
1.3 術(shù)語
列出本報告中專門術(shù)語的定義和英文縮寫詞的原詞組。
1.4 人員
給出本軟件的開發(fā)人員。
姓名 部門 職務(wù)或角色 電話
1.5 參考資料:
列出編寫參考的文件、資料、技術(shù)標(biāo)準(zhǔn)以及他們的作者、標(biāo)題、編號、發(fā)布日期和出版單位。
編號 資料名稱 簡介 作者 日期 出版單位
列出編寫本報告時需查閱的Intenet上雜志、專業(yè)著作、技術(shù)標(biāo)準(zhǔn)以及他們的網(wǎng)址。
網(wǎng)點 簡介
2. 系統(tǒng)概述
2.1 適用范圍及系統(tǒng)特性簡要說明
簡述本軟件系統(tǒng)適用的領(lǐng)域、功能要點、產(chǎn)品化程度。
2.2 子系統(tǒng)及其模塊的劃分
給出系統(tǒng)中各個子系統(tǒng)及其模塊簡要的功能描述,并用圖形的方式給出各個子系統(tǒng)及其模塊之間的關(guān)系。如果本軟件系統(tǒng)是一個更大的系統(tǒng)的一個組成部分,則還要說明本軟件系統(tǒng)與這個更大的系統(tǒng)中的其他各組成部分之間的關(guān)系。
2.3 系統(tǒng)運行環(huán)境
給出本軟件系統(tǒng)運行所需的基本軟/硬件環(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è)計報告》)則可直接在此引述該文件名及歸檔的部門即可。
3. 文件一覽
3.1 系統(tǒng)運行文件一覽
給出本軟件系統(tǒng)(或分別給出各子系統(tǒng))運行時其各種文件系統(tǒng)目錄、文件一覽表,并說明其意義、內(nèi)容等。
3.2 源程序文件一覽
給出本軟件系統(tǒng)(或分別給出各子系統(tǒng))源程序文件及頭文件目錄、文件一覽表,并簡要說明各源程序文件所包含的內(nèi)容、與子系統(tǒng)及其模塊的對應(yīng)關(guān)系。
3.3 函數(shù)、類、事件一覽(可選)
按照源程序文件一覽的順序,給出源程序文件中函數(shù)、類、事件的說明。具體要求如下:
1) 函數(shù)的功能:必要時簡要給出算法;
2) 函數(shù)調(diào)用參數(shù)及返回值:說明各參數(shù)及返回值的作用、意義及其取值范圍。
4. 數(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è)計報告》)則可直接在此引述該文件名及歸檔的部門即可。
5. 可重用子系統(tǒng)或模塊
以列表的方式給出本軟件系統(tǒng)中可被其它系統(tǒng)應(yīng)用的子系統(tǒng)或模塊,說明這些可重用子系統(tǒng)或模塊的應(yīng)用范圍。
6. 總結(jié)與展望
說明本軟件系統(tǒng)在開發(fā)過程中的經(jīng)驗與教訓(xùn),尚存的功能、可靠性等方面的問題,該軟件系統(tǒng)以后的發(fā)展方向及再開發(fā)策略
技術(shù)報告編寫規(guī)范
文件修改控制
修改記錄編號 修改
狀態(tài) 修改頁碼及條款 修改人 審核人 批準(zhǔn)人 修改日期
目錄
1. 目的
2. 適用范圍
3. 術(shù)語及縮略語
4. 編寫規(guī)范
4.1 排版規(guī)范
4.2 模板使用
5. 引用文件
6. 附錄
1. 目的
技術(shù)報告編寫規(guī)范主要描述在軟件產(chǎn)品或軟件項目開發(fā)完成時所需編寫的技術(shù)報告應(yīng)該包含的內(nèi)容,使得本公司編寫的技術(shù)報告便于軟件產(chǎn)品或軟件項目日后的維護(hù)、交接和代碼重用。
2. 適用范圍
適用于本公司軟件產(chǎn)品或軟件項目的技術(shù)報告的編寫。
3. 術(shù)語及縮略語
本程序采用NQ402100《質(zhì)量手冊》中的術(shù)語和縮略語及其定義。
4. 編寫規(guī)范
4.1 排版規(guī)范
1) 整個規(guī)范由2節(jié)構(gòu)成,模板單獨一節(jié)。
2) 正文樣式采用“規(guī)范正文”。
3) 標(biāo)題編號采用每節(jié)獨立編號。
4.2 模板使用
1) 拷貝規(guī)范。
2) 刪除第一節(jié)(技術(shù)報告封面前的所有頁)。
3) 在修改完內(nèi)容后,更新目錄域和相關(guān)的頁數(shù)域。
5. 引用文件
(無)
6. 附錄
以下部分為技術(shù)報告的模板。
密級:機(jī)密
文檔編號: 第 版
分冊名稱: 第 冊/共 冊
項目名稱(項目編號)
技術(shù)報告
(部門名稱)
沈陽東大阿爾派軟件股份有限公司
總頁數(shù) 正文 附錄 生效日期: 年 月 日
編制: 審核: 批準(zhǔn):
目錄
1. 引言 3
1.1 目的 3
1.2 背景 3
1.3 術(shù)語 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é)構(gòu) 4
5. 可重用子系統(tǒng)或模塊 4
6. 總結(jié)與展望 4
1. 引言
1.1 目的
說明編寫本《技術(shù)報告》的目的。
1.2 背景
說明理解本報告所需的背景,如與公司其它軟件之間的聯(lián)系等。
1.3 術(shù)語
列出本報告中專門術(shù)語的定義和英文縮寫詞的原詞組。
1.4 人員
給出本軟件的開發(fā)人員。
姓名 部門 職務(wù)或角色 電話
1.5 參考資料:
列出編寫參考的文件、資料、技術(shù)標(biāo)準(zhǔn)以及他們的作者、標(biāo)題、編號、發(fā)布日期和出版單位。
編號 資料名稱 簡介 作者 日期 出版單位
列出編寫本報告時需查閱的Intenet上雜志、專業(yè)著作、技術(shù)標(biāo)準(zhǔn)以及他們的網(wǎng)址。
網(wǎng)點 簡介
2. 系統(tǒng)概述
2.1 適用范圍及系統(tǒng)特性簡要說明
簡述本軟件系統(tǒng)適用的領(lǐng)域、功能要點、產(chǎn)品化程度。
2.2 子系統(tǒng)及其模塊的劃分
給出系統(tǒng)中各個子系統(tǒng)及其模塊簡要的功能描述,并用圖形的方式給出各個子系統(tǒng)及其模塊之間的關(guān)系。如果本軟件系統(tǒng)是一個更大的系統(tǒng)的一個組成部分,則還要說明本軟件系統(tǒng)與這個更大的系統(tǒng)中的其他各組成部分之間的關(guān)系。
2.3 系統(tǒng)運行環(huán)境
給出本軟件系統(tǒng)運行所需的基本軟/硬件環(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è)計報告》)則可直接在此引述該文件名及歸檔的部門即可。
3. 文件一覽
3.1 系統(tǒng)運行文件一覽
給出本軟件系統(tǒng)(或分別給出各子系統(tǒng))運行時其各種文件系統(tǒng)目錄、文件一覽表,并說明其意義、內(nèi)容等。
3.2 源程序文件一覽
給出本軟件系統(tǒng)(或分別給出各子系統(tǒng))源程序文件及頭文件目錄、文件一覽表,并簡要說明各源程序文件所包含的內(nèi)容、與子系統(tǒng)及其模塊的對應(yīng)關(guān)系。
3.3 函數(shù)、類、事件一覽(可選)
按照源程序文件一覽的順序,給出源程序文件中函數(shù)、類、事件的說明。具體要求如下:
1) 函數(shù)的功能:必要時簡要給出算法;
2) 函數(shù)調(diào)用參數(shù)及返回值:說明各參數(shù)及返回值的作用、意義及其取值范圍。
4. 數(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è)計報告》)則可直接在此引述該文件名及歸檔的部門即可。
5. 可重用子系統(tǒng)或模塊
以列表的方式給出本軟件系統(tǒng)中可被其它系統(tǒng)應(yīng)用的子系統(tǒng)或模塊,說明這些可重用子系統(tǒng)或模塊的應(yīng)用范圍。
6. 總結(jié)與展望
說明本軟件系統(tǒng)在開發(fā)過程中的經(jīng)驗與教訓(xùn),尚存的功能、可靠性等方面的問題,該軟件系統(tǒng)以后的發(fā)展方向及再開發(fā)策略
技術(shù)報告編寫規(guī)范
[下載聲明]
1.本站的所有資料均為資料作者提供和網(wǎng)友推薦收集整理而來,僅供學(xué)習(xí)和研究交流使用。如有侵犯到您版權(quán)的,請來電指出,本站將立即改正。電話:010-82593357。
2、訪問管理資源網(wǎng)的用戶必須明白,本站對提供下載的學(xué)習(xí)資料等不擁有任何權(quán)利,版權(quán)歸該下載資源的合法擁有者所有。
3、本站保證站內(nèi)提供的所有可下載資源都是按“原樣”提供,本站未做過任何改動;但本網(wǎng)站不保證本站提供的下載資源的準(zhǔn)確性、安全性和完整性;同時本網(wǎng)站也不承擔(dān)用戶因使用這些下載資源對自己和他人造成任何形式的損失或傷害。
4、未經(jīng)本網(wǎng)站的明確許可,任何人不得大量鏈接本站下載資源;不得復(fù)制或仿造本網(wǎng)站。本網(wǎng)站對其自行開發(fā)的或和他人共同開發(fā)的所有內(nèi)容、技術(shù)手段和服務(wù)擁有全部知識產(chǎn)權(quán),任何人不得侵害或破壞,也不得擅自使用。
我要上傳資料,請點我!
管理工具分類
ISO認(rèn)證課程講義管理表格合同大全法規(guī)條例營銷資料方案報告說明標(biāo)準(zhǔn)管理戰(zhàn)略商業(yè)計劃書市場分析戰(zhàn)略經(jīng)營策劃方案培訓(xùn)講義企業(yè)上市采購物流電子商務(wù)質(zhì)量管理企業(yè)名錄生產(chǎn)管理金融知識電子書客戶管理企業(yè)文化報告論文項目管理財務(wù)資料固定資產(chǎn)人力資源管理制度工作分析績效考核資料面試招聘人才測評崗位管理職業(yè)規(guī)劃KPI績效指標(biāo)勞資關(guān)系薪酬激勵人力資源案例人事表格考勤管理人事制度薪資表格薪資制度招聘面試表格崗位分析員工管理薪酬管理績效管理入職指引薪酬設(shè)計績效管理績效管理培訓(xùn)績效管理方案平衡計分卡績效評估績效考核表格人力資源規(guī)劃安全管理制度經(jīng)營管理制度組織機(jī)構(gòu)管理辦公總務(wù)管理財務(wù)管理制度質(zhì)量管理制度會計管理制度代理連鎖制度銷售管理制度倉庫管理制度CI管理制度廣告策劃制度工程管理制度采購管理制度生產(chǎn)管理制度進(jìn)出口制度考勤管理制度人事管理制度員工福利制度咨詢診斷制度信息管理制度員工培訓(xùn)制度辦公室制度人力資源管理企業(yè)培訓(xùn)績效考核其它
精品推薦
下載排行
- 1社會保障基礎(chǔ)知識(ppt) 16695
- 2安全生產(chǎn)事故案例分析(ppt 16695
- 3行政專員崗位職責(zé) 16695
- 4品管部崗位職責(zé)與任職要求 16695
- 5員工守則 16695
- 6軟件驗收報告 16695
- 7問卷調(diào)查表(范例) 16695
- 8工資發(fā)放明細(xì)表 16695
- 9文件簽收單 16695
- 10跟我學(xué)禮儀 16695