IT技術(shù)研發(fā)文檔模板(2個(gè)doc)1.doc

第一部分 前言 在第一次研發(fā)中心內(nèi)部（技術(shù)二部）的廣泛討論與征求意見的基礎(chǔ)上，經(jīng)過總結(jié)，形成“技術(shù)文檔規(guī)范EY2003-11-V0.20”。改動(dòng)部分大體有以下幾個(gè)方面：（1） “配置編號”編制規(guī)則；（2） “需求分析說明書/報(bào)告”，模板部分（3） 在需求部分以附件的形式增加 “最新需求確定” 模板，由技術(shù)研發(fā)中心 蘇正華負(fù)責(zé)起草（4） 統(tǒng)一文檔原創(chuàng)者身份為 “作者”（5） 文檔模板中統(tǒng)一一項(xiàng)內(nèi)容 “產(chǎn)品名稱”（6） “需求/功能變更說明書” 模板中增加 “負(fù)責(zé)人簽字” 項(xiàng)（7） “數(shù)據(jù)庫設(shè)計(jì)報(bào)告（S）” 模板 增加 “主鍵” 項(xiàng)，“關(guān)聯(lián)關(guān)系描述”項(xiàng)，存儲過程項(xiàng)，觸發(fā)器項(xiàng)（8） 產(chǎn)品測試報(bào)告（SP1）與（SP2）合并為一套模板，并在 測試項(xiàng) 遺留問題項(xiàng) 中有多處變動(dòng)，新增 新問題 項(xiàng)（9） 以 附件 形式 增加 “測試方案” 模板， 由由技術(shù)研發(fā)中心 蘇正華負(fù)責(zé)起草（10） 在 V0.10 的 “第三部分 內(nèi)容” 第一項(xiàng) “版本控制規(guī)則” 中 版本號 增為4位數(shù)字（11） 在 V0.10 的 “第三部分 內(nèi)容” 第七項(xiàng) “詳細(xì)設(shè)計(jì)” 中 有關(guān)代碼文件的說明 部分 增加 注釋 改動(dòng)內(nèi)容 項(xiàng) 在本版中，將不再有V0.10中解釋與說明的部分，缺少的必要部分將補(bǔ)充到本版中。 第一部分 變動(dòng)內(nèi)容說明一版本控制規(guī)則（1） 版本狀態(tài)：Alfa ，Beta，Deta/內(nèi)部測試版，Release/對外正式發(fā)布版，Changing/內(nèi)部變更狀態(tài)（2） 版本號：版本號以四位數(shù)字表示，格式為i.jk.l（i=0，1，2，n；jkl=001，999）a. Alfa版，i=0b. 第一次正式發(fā)布的Release版，1.00c. 用Changing來表示內(nèi)部測試版或Release版本的內(nèi)部修改或升級狀態(tài)d. 小的改動(dòng)或升級i，jk保持不變，只增加l值即可，l的升值幅度為修改或升級處的數(shù)目，當(dāng)l值達(dá)到或增加至9時(shí)，l=l+1，l=0e. 比較大的改動(dòng)如，一次修改或升級處的數(shù)目10，功能性的增加或改變，則i.j保持不變，增加k值。如果是功能性的修改或變動(dòng)，每有一項(xiàng)k+1；如果是10的非功能性的修改，每9處修改，k+1，個(gè)數(shù)部分用l來表示f. 重大變動(dòng)，j值增加g. 在Alfa版狀態(tài)下，如果變動(dòng)累計(jì)超出999次，則Alfa版升級到Beta版，依次類推二配置編號 編制規(guī)則及說明（1） 編制規(guī)則：格式：EPD + 年份 + -所在年份項(xiàng)目號 + “-“ + 模板序號 + “-“ + H/S + “-“ + 模板編號 + “-” +附件標(biāo)示A +”-“+ 附件編號 舉例：EPD2003No5-05-S-01-A-01， 表示2003年第5號項(xiàng)目的第5份模板，是軟件部分的模板，當(dāng)前模板為為第5份模板的第1部分（2） 說明：a. 文檔配置編號由專業(yè)技術(shù)秘書或技術(shù)文檔管理員 統(tǒng)一分配制定。b. H，表示硬件；S，表示軟件c. A，表示附件；如果有多個(gè)附件，則從01開始依次編制。如果沒有附件，省略三需求分析說明書/報(bào)告需求分析說明書/報(bào)告配置編號EPD2003NoX-02-S-01作者提交時(shí)間2003-8-18產(chǎn)品名稱目標(biāo)用戶陳述產(chǎn)品的目標(biāo)用戶需求陳述內(nèi)容級別1A B C2解決方法簡單描述針對需求的初步解決意向附加說明討論意見項(xiàng)目評審委員會(huì)結(jié)論四需求/功能變更 說明書需求/功能變更 說明書配置編號EPD2003NoX-02-S-02當(dāng)前版本V2.17歷史版本V2.00產(chǎn)品名稱作者時(shí)間2003-8-19變更項(xiàng)變更內(nèi)容變更屬性變更理由陳述是否允許1A D M是 否23附加說明變更屬性中A代表增加，D代表刪除，M代表修改項(xiàng)目評審委員會(huì)結(jié)論項(xiàng)目評審委員會(huì)給出是否進(jìn)行變更的意見，由評委會(huì)主席簽字生效負(fù)責(zé)人簽字最新需求確定模板，附件五數(shù)據(jù)庫設(shè)計(jì)報(bào)告（S）數(shù)據(jù)庫設(shè)計(jì)報(bào)告（S）配置編號EPD2003NoX-05-S-01作者時(shí)間2003-8-19當(dāng)前版本V1.20歷史版本V1.17表匯總表名功能描述1A2B3CA列名(主鍵)數(shù)據(jù)類型（精度范圍）約束條件備注12補(bǔ)充說明角色與權(quán)限可以訪問的表與列訪問權(quán)限角色A角色B關(guān)聯(lián)關(guān)系描述存儲過程名稱腳本描述用途12觸發(fā)器名稱腳本描述用途12六功能定義說明書功能定義說明書配置編號EPD2003NoX-04-S-01作者提交時(shí)間2003-8-19產(chǎn)品名稱當(dāng)前版本歷史版本功能項(xiàng)功能名稱功能描述123附加說明項(xiàng)目評審委員會(huì)意見項(xiàng)目評審委員會(huì)給出整體意見，供決策人參考負(fù)責(zé)人簽字七功能定義變更說明書功能變更說明書配置編號EPD2003NoX-04-S-02作者提交時(shí)間2003-8-19產(chǎn)品名稱當(dāng)前版本歷史版本變更項(xiàng)原功能名稱新功能名稱變更屬性變更理由陳述是否允許1A D M是 否23附加說明項(xiàng)目評審委員會(huì)意見項(xiàng)目評審委員會(huì)給出整體意見，供決策人參考負(fù)責(zé)人簽字最新功能定義說明書模板，附件八概要設(shè)計(jì)概要設(shè)計(jì)報(bào)告（S）配置編號EPD2003NoX-05-S-01作者提交時(shí)間2003-8-19產(chǎn)品名稱V1.20當(dāng)前版本ChangingV1.17歷史版本ReleaseV1.07術(shù)語與縮寫解釋術(shù)語解釋G-BIAS即GPS-Based Integrated Application System設(shè)計(jì)約束系統(tǒng)應(yīng)當(dāng)遵循的標(biāo)準(zhǔn)或規(guī)范軟硬件環(huán)境（包括運(yùn)行環(huán)境與開發(fā)環(huán)境）的約束接口/協(xié)議的約束用戶界面的約束*軟件質(zhì)量約束，包括正確性，健壯性，可靠性，效率（性能），易用性，清晰性，安全性，可擴(kuò)展性，兼容性，可移植性。（如果有約束，逐一填寫；如果不存在約束，可不填）設(shè)計(jì)策略擴(kuò)展策略為了方便擴(kuò)展，現(xiàn)在采取的措施復(fù)用策略說明本系統(tǒng)在當(dāng)前以及將來的復(fù)用策略折衷策略如果存在兩個(gè)主要目標(biāo)難以同時(shí)優(yōu)化時(shí)如何折衷系統(tǒng)總體結(jié)構(gòu)描述凡是用圖表示的部分，均用MS Visio2002繪制，左邊為圖，右邊為文字說明開發(fā)環(huán)境配置軟件硬件網(wǎng)絡(luò)主要開發(fā)工具及語言運(yùn)行環(huán)境要求軟件包括操作系統(tǒng)，第三方軟件平臺硬件網(wǎng)絡(luò)數(shù)據(jù)庫參考資料資料配置編號來源12其他說明九產(chǎn)品測試報(bào)告產(chǎn)品測試報(bào)告（ST1）配置編號EPD2003NoX-07-S-01-01測試人測試時(shí)間2003-8-21產(chǎn)品名稱版本歷史版本測試環(huán)境及工具操作系統(tǒng)網(wǎng)絡(luò)環(huán)境支持軟件硬件設(shè)備及版本其他測試項(xiàng)功能是否通過問題級別備注1Yes NoR Y O2問題項(xiàng)功能問題描述測試流程原因分析nm新問題問題描述問題級別測試流程原因分析1R Y O測試結(jié)論測試人簽字手寫測試反饋報(bào)告產(chǎn)品測試反饋報(bào)告（ST2）配置編號EPD2003NoX-07-S-02-01作者測試時(shí)間產(chǎn)品名稱版本歷史版本問題項(xiàng)功能問題原因是否解決解決方法mYes Non附加說明負(fù)責(zé)人簽字手寫開發(fā)人員簽字手寫十有關(guān)代碼文件的說明 部分 增加 注釋 改動(dòng)內(nèi)容 項(xiàng)（1） 所有的代碼模塊必須用文件的方式組織（2） 在每一個(gè)文件中的開頭以注釋的方式寫如下內(nèi)容：Copyright（c）2003，*公司，硬件開發(fā)部*All rights reserved*文件名稱：*文件標(biāo)識：文件標(biāo)識可以統(tǒng)一規(guī)定，也可以自己選擇*摘 要：簡要描述該文件的內(nèi)容*當(dāng)前版本：*作 者：輸入作者或修改者的名字*改動(dòng)說明：*完成日期：*取代版本：*原作者 ：*完成日期：（3） 如果用C語言開發(fā)a. 必須將.H文件與.C文件區(qū)分開來，在.H中定義全局變量，結(jié)構(gòu)，聯(lián)合，自定義群體等，如鏈表；函數(shù)的聲明b. 在定義函數(shù)體前，以注釋方式寫如下內(nèi)容*函數(shù)的主要作用*輸入輸出參數(shù)的含義（4） 全局變量的定義要集中，并說明用途（5） 主要變量必須在定義之后說明用途（6） 所有函數(shù)的定義必須給出函數(shù)的作用sample:/*Copyright (c) XXX*All rights reserved.*Author :XXX*e-mail : chr