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