項(xiàng)目文檔命名規(guī)則及格式要求(同名6699)

1、項(xiàng)目文檔命名規(guī)則編制：日期：/審核： 日期：_/_/批準(zhǔn)： 日期：/xxxx公司二零一五年五月制歷史記錄編p章節(jié)名稱說明修訂日期版本號修訂人發(fā)布日期01全文新建1.002修訂章節(jié)4.11.11 目的 42 適用范圍 43 術(shù)語和縮略詞 44 規(guī)程 44.1 文檔命名規(guī)則 44.2 配置項(xiàng)的版本標(biāo)識 84.3 標(biāo)簽的命名 91目的本文的目的是定義各項(xiàng)目所有相關(guān)文檔和cm限求的過程文件的格式和規(guī)則，以及配置管理中對配置項(xiàng)和版本的標(biāo)識。2適用范圍本規(guī)則適用于所有需求、設(shè)計(jì)等文檔和過程文件。3術(shù)語和縮略詞無4規(guī)程4.1文檔命名規(guī)則1 組織標(biāo)準(zhǔn)軟件過程文檔編號(1) 過程文件格式： xxx-p-xx,初

2、始編號為：xxx-p-01,最大編號為： xxx-p-99。(2)指南文件編號：xxx-g-x x x x ,前兩位x x為指南所對應(yīng)的過程文件編號。(3)模板文件編號：xxx-t-xxxx,前兩位x x為指南所對應(yīng)的過程文件編號。2 產(chǎn)品命名規(guī)范(1)中文命名規(guī)范：中文全稱v產(chǎn)品版本號。英文命名規(guī)范：首字母大寫v產(chǎn)品版本號。3 項(xiàng)目文檔編號(1)編號規(guī)則分三種：1)單個(gè)文檔：首字母大寫 v產(chǎn)品版本號-階段英文縮寫-文檔名稱英文縮寫。2)多個(gè)子文檔：首字母大寫v產(chǎn)品版本號-階段英文縮寫-文檔名稱英文縮寫一流 水號。3)周期性：首字母大寫 v產(chǎn)品版本號-文檔名稱/英文名稱-八位日期。(2)項(xiàng)目階

3、段及文檔名稱英文縮寫，見下表:階段序號文檔名稱英文及縮寫產(chǎn)品調(diào)研(pi)1產(chǎn)品調(diào)研任務(wù)書pia(project investigateassignment)2產(chǎn)品調(diào)研計(jì)劃pip(project investigate plan)3競爭對手產(chǎn)品對比差異分析報(bào)告opa(opponent productdifference analyse report)4標(biāo)準(zhǔn)吻合度分析報(bào)告smr(standard match report)5產(chǎn)品系統(tǒng)需求psr(product systemrequirement )技術(shù)預(yù)研(ts)1xx技術(shù)預(yù)研計(jì)劃tsp(technology study plan)2xx技術(shù)預(yù)研報(bào)

4、告tsr(technology study report)3技術(shù)可行性分析報(bào)告tfa(technology feasibilityanalyse report)4產(chǎn)品系統(tǒng)需求psr(product systemrequirement )計(jì)劃與 立項(xiàng) (pp)1產(chǎn)品需求規(guī)格說明書srs(product requirementspecification)2項(xiàng)目開發(fā)計(jì)劃pdp(product development plan)3風(fēng)險(xiǎn)管理計(jì)劃rmp(risk management plan)4產(chǎn)品系統(tǒng)測試計(jì)劃ptp(product test plan)5質(zhì)量保證計(jì)劃qap(quality assura

5、nce plan)6配置管理計(jì)劃cmp(configuration management plan)7項(xiàng)目會議記錄meeting8產(chǎn)品工程計(jì)劃與進(jìn)度跟表pst(product schedule trace)9產(chǎn)品界面原型設(shè)計(jì)uid(user interface design)10產(chǎn)品任務(wù)書無需11廣叩立項(xiàng)申請書psa(product start apply)設(shè)計(jì)(de)1產(chǎn)品總體設(shè)計(jì)說明書psd(product system design)2xx模塊概要設(shè)計(jì)說明書hld(high level design)3xx模塊詳細(xì)設(shè)計(jì)說明書dd(detail design)編碼、單 元測試 (cut)1

6、產(chǎn)品單元測試匯總報(bào)告utr(product unit test report)2用戶手冊無需3產(chǎn)品集成測試用例itc(product integerate test case)4集成測試計(jì)劃itp(integerate test plan)集成測 試(it)1產(chǎn)品集成測試報(bào)告itr(integerate test report)2產(chǎn)品系統(tǒng)測試用例stc(system test case)增量測 試和系 統(tǒng)測試 (st)1測試入口檢查單無需2系統(tǒng)測試方案stp(system test plan)3增量測試方案atp(alternate test plan)4增量測試報(bào)告atr(alternate

7、 test report)5系統(tǒng)測試報(bào)告str(system test report)4 文檔版本 格式：vx x x . xxx,初始版本號為v0.1 ,最大版本號為：v999.999。其中,草稿狀態(tài)的版本均為 v0. xxx ,例如：v0.1 , v0.2v0.999 ;而經(jīng)過評審?fù)ㄟ^的文檔版本均從v1.0 開始，例如： v1.0 ， v1.1 ， v2.0 等。5 密級程度(1) 文檔(包括電子文檔和紙質(zhì)文檔)的密級分為三級，由低到高分別是：公開級、限制級、核心級：1) 公開級的文檔使用的范圍不受約束， 例如研發(fā)人員，生產(chǎn)人員、市場人員、行政人員和產(chǎn)品用戶等；包括 用戶手冊、技術(shù)白皮書、

8、產(chǎn)品安裝說明、宣傳資料等。2) 限制級的文檔使用的范圍僅限于研發(fā)內(nèi)部的人員或生產(chǎn)人員；包括研發(fā)制度和規(guī)范、計(jì)劃、產(chǎn)品需求、總體設(shè)計(jì)、模塊設(shè)計(jì)、詳細(xì)設(shè)計(jì)、測試用例、測試報(bào)告、評審文檔、生產(chǎn)資料等。3) 核心級的文檔使用的范圍僅限于研發(fā)開發(fā)經(jīng)理以上的人員。包括產(chǎn)品源碼、產(chǎn)品鏡像文件、公司或部門的敏感文件。(2) 密級標(biāo)注密級在密級標(biāo)識欄中填寫，若無標(biāo)識欄則在文檔的右上角標(biāo)注密級。6 文檔編寫格式文檔編寫可以從研發(fā)模板庫中取得相應(yīng)模板進(jìn)行編寫， 也可根據(jù)格式要求進(jìn)行編寫， 具體格式要求如下：(1) 封面1) 頁眉、頁腳空白2) 封面上方文檔編號表格? 屬性：文字環(huán)繞-無?置頂，上面無空行?中文宋體、

9、英文arial ，全部加粗，宋體， 10.5 號3) 標(biāo)題?2 行：第一行：產(chǎn)品中文名稱vx.x ；第二行：文檔名稱? 小一號字體，黑體， arial ，加粗? 段前段后 2.6磅，單倍行距；無縮進(jìn)，無懸掛? 上方空 2 行，下方空3 行4) 簽核欄位? 四號字體，宋體， arial ，加粗? 簽核欄位 4 欄， 到部門批準(zhǔn) (研發(fā)副總) ； 簽核欄位 5 欄， 到批準(zhǔn) (郭總) 。具體的簽核欄位數(shù)見研發(fā)過程文檔命名及簽批流程.xls ? 左側(cè)縮進(jìn) 4 字符，右側(cè)縮進(jìn) -4.16 字符，無懸掛；段前段后2.6 磅，單倍行距5) 模板制度日期?“ xxxx 公司” “二零 xx 年 x 月制”分

10、兩行；? 小三號字體，黑體， arial ，加粗；居中?段前段后0 行，單倍行距；無縮進(jìn)，無懸掛?下方插入分節(jié)符“下一頁”(2) 歷史記錄1) “歷史記錄”?小三，黑體，不加粗?段前段后0 行，單倍行距2) 表格? 屬性：文字環(huán)繞選無；行高，0.6，最?。辉O(shè)置“在各頁端以標(biāo)題行形式重復(fù)出現(xiàn)”?表頭：五號，宋體，加粗，全部居中?格式：五號，宋體，arial，不加粗，全部居中? 內(nèi)容：日期格式為yyyy.mm.dd ，版本號 vx.x?表格下方插入分節(jié)符-下一頁3) 頁眉、頁腳?頁眉：?頁腳：開始插入頁碼，頁碼格式為“第x 頁 共 x 頁” ，小五號，宋體，arial ，居中(3) 目錄2) “目

11、錄”?字體：小三，黑體，不加粗? “目錄”兩個(gè)字中間空2 個(gè)字? 段前段后 0 行，多倍行距，設(shè)置選33) 目錄內(nèi)容? 來自模板，顯示級別 3 級，不加冒號4) 頁眉、頁腳? 頁眉：? 頁腳：插入頁碼，頁碼格式為“第x 頁 共 x 頁” ，小五號，宋體， arial ，居中(4) 正文1) 標(biāo)題： 字體均采用宋體加黑， 標(biāo)題一為小三號字體， 標(biāo)題二為四號， 依次類推。 段落為單倍行距。2) 標(biāo)題一段落段前13 磅，段后 6 磅；標(biāo)題二段落段前段后 6 磅；3) 頁眉頁腳：頁眉格式：左上角標(biāo)注“西安交大公司網(wǎng)絡(luò)科技有限公司” ，右上角標(biāo)注文檔名稱；頁腳格式：第 項(xiàng)共x頁，封面不顯示頁碼。4) 內(nèi)

12、容：正文，字體，宋體， arial ，五號，不加粗，兩端對齊，首行縮進(jìn) 2 字 符，段后 0 行， 1.5 倍行距。(5) 表格1) 表頭：字體宋體，arial ，五號，加粗；上下居中，水平居中；表格底紋設(shè)置為灰度 25%2) 內(nèi)容：字體宋體，arial ，五號，不加粗3) 行高：0.6cm,最小值4) 寬度：設(shè)置為頁面寬度(6) 流程圖均采用 visio 畫圖，底色均為默認(rèn)的白色，圖中字體均為宋體，大小采用五號字體或 10pt 大小字體。(7) 頁邊距：上下2.54 厘米，左右3.17 厘米均采用 visio 畫圖，底色均為默認(rèn)的白色，圖中字體均為宋體，大小采用五號字體或 10pt 大小字體

13、。4.2 配置項(xiàng)的版本標(biāo)識根據(jù)產(chǎn)品的需要， 軟件產(chǎn)品制造過程中的每個(gè)配置項(xiàng)和不同階段的基線發(fā)布都需要進(jìn)行相應(yīng)的版本標(biāo)識，下面分別介紹。1、配置項(xiàng)版本標(biāo)識對于文檔、軟件和硬件的版本號，項(xiàng)目過程中采用三位編碼的原則，格式如下：vxxx.xxx.xxxx ，初始版本號為 v1.0.0 ，最大版本號為： v999.999.9999.例如： v1.0.0 ； v82.456.15在個(gè)人工作區(qū)如果對文檔或編碼進(jìn)行修改，版本號的第三位迭代 1 ，如 v1.0.1 。文檔、軟件和硬件的各配置項(xiàng)的版本號第二位應(yīng)統(tǒng)一。從個(gè)人工作區(qū)提交到開發(fā)區(qū)時(shí)， 由項(xiàng)目經(jīng)理控制版本號的第二位的迭代。 建議： 如果其中一項(xiàng)的特征進(jìn)

14、行了較大修改或者增加了新特性， 第二位迭代 1， 第三位恢復(fù)為 0。如 v1.1.0 。從開發(fā)區(qū)提交到基線區(qū)時(shí)，由sccb$制版本號的第一位的迭代，進(jìn)行一次變更版本號的第二位迭代1,并由scm去掉版本號的第三位后放入基線區(qū)。如： v56.45。2、基線版本標(biāo)識scm責(zé)人負(fù)責(zé)把基線發(fā)布給外部客戶（如發(fā)布運(yùn)行基線）或內(nèi)部使用（如為測試而發(fā)布） ?；€的版本號采用兩位編號原則，格式如下：vxxx.xxx, 初始版本號為 v1.0. ，最大版本號為 v999.999 。例如： v1.0 ； v33.994.3 標(biāo)簽的命名scm 人員負(fù)責(zé)對開發(fā)過程中的重要里程碑及基線進(jìn)行標(biāo)簽的標(biāo)注。標(biāo)簽的命名不可隨意為之，要讓標(biāo)簽名稱具有很強(qiáng)的自說明性，并且盡量不要過于復(fù)雜。標(biāo)簽命名分為以下兩種情況：a） 正是基線命名標(biāo)簽名稱必須以該項(xiàng)目組產(chǎn)品名稱的英文字母開頭，格式如下：產(chǎn)品英文名稱版本號_rel+標(biāo)簽版本號，其中“版本號”指的是所開發(fā)產(chǎn)品的版本，初始版本號為v1_0 ，最大版本號為v999_999 ；而“標(biāo)簽版本號”指的是每次打標(biāo)簽遞增的序號，范圍從0