軟件研發(fā)版本管理制度.doc

1、軟件研發(fā)版本管理制度軟件研發(fā)版本管理制度泰豪軟件研發(fā)版本管理規(guī)范v1.0研發(fā)部 文檔類別使用對(duì)象 文檔類別 該文檔是為泰豪 公司提供一個(gè)版本管理規(guī)范性文件。使用對(duì)象該文檔使用對(duì)象為泰豪軟件公司研發(fā)本部各 部門項(xiàng)目經(jīng)理及版本管理人員，以及其他相關(guān)人員。未經(jīng)許可，該文檔不得提供給上述規(guī)定對(duì)象以外的人員 閱讀或使用。1引言1.1目的本文檔是為規(guī)范泰豪軟件公司研發(fā)版 本管理而制定的。1.2范圍 本文檔為各產(chǎn)品部、事業(yè)部版本管理員提供有 關(guān)版本管理規(guī)范的相關(guān)內(nèi)容，包括版本標(biāo)識(shí)方法 軟件系統(tǒng)數(shù)據(jù)的存放 文檔的修改控制 文檔的備份制度1.3術(shù)語(yǔ)定義 SVN Svn是一個(gè)開(kāi)源的版本控制系統(tǒng) Subversio

2、n的簡(jiǎn)稱文 檔一種數(shù)據(jù)媒體和其上所記錄的數(shù)據(jù)。配置管理 標(biāo)識(shí)和確定系統(tǒng)中配置項(xiàng)的過(guò)程，在系統(tǒng)整 個(gè)生存周期內(nèi)控制這些項(xiàng)的投放和更動(dòng)，記錄并報(bào)告配置的 狀態(tài)和更動(dòng)要求，驗(yàn)證配置項(xiàng)的完整性和正確性。軟件配置 軟件的具體形態(tài)在莫時(shí)刻的瞬時(shí)影像。配置項(xiàng)軟件配置管理的對(duì)象稱為配置項(xiàng)，如系統(tǒng)規(guī)格 說(shuō)明書，項(xiàng)目開(kāi)發(fā)計(jì)劃，用戶手冊(cè)，源碼?；€ 軟件生存周期中各開(kāi)發(fā)階段末尾的標(biāo)記，它的作用是把各階段工作的劃分更加明確化，使本來(lái)連續(xù)的工作在 這些點(diǎn)上斷開(kāi)，使之便于檢驗(yàn)和肯定階段成果。1.4版序控制記錄 版序狀態(tài) 擬稿 審核 批準(zhǔn) 發(fā)布日期1.0研發(fā)部09/11/18張洪興1.5版本更新記錄 *A -增加 M -修

3、改D -刪除版本/修訂版修改頁(yè)碼 修改記錄 修改 人日期1.0初始版本2009/02 2版本管理21版本標(biāo)識(shí)方 法 為了使工作規(guī)范化、統(tǒng)一化，各項(xiàng)目組實(shí)行的版本標(biāo)識(shí) 管理方法分為正式版本和特殊版本。211正式版本 公司在市場(chǎng)上發(fā)行的正規(guī)版本。以“V開(kāi)頭，版本號(hào)放后。V前面增加項(xiàng)目名稱，版本號(hào)分3節(jié)主版本號(hào)，版本號(hào)和內(nèi)部版本號(hào)，每節(jié)之間以小數(shù)點(diǎn).間隔。如V2.0.1表示主版本號(hào)為2,次版本號(hào)為0,內(nèi)部版本號(hào) 為1。研發(fā)部控制主版本號(hào)和次版本號(hào)，各項(xiàng)目組控制內(nèi)部版 本號(hào)。例如一體化平臺(tái)-平陰版v1.1.1 , 一體化平臺(tái)為產(chǎn)品名 稱，平陰版為版本名稱平陰為具體項(xiàng)目名稱，V1.1.1為主版本號(hào)次版本

4、號(hào)內(nèi)部版本號(hào)。22目錄結(jié)構(gòu) 由于各項(xiàng)目組的實(shí)際情況不同，目錄結(jié)構(gòu) 很難統(tǒng)一，但為了能更好地管理各項(xiàng)目組的文檔，建議可將 被管理的配置項(xiàng)分為三大類文檔類、源碼類及安裝盤類，這樣存放比較清晰，有利于版本管理。至于二級(jí)目錄是以版本劃分，并根據(jù)制定的目錄結(jié)構(gòu)給 由文件級(jí)目錄清單先給生源程序及文檔的文件級(jí)目錄清單， 安裝盤的可以后再執(zhí)行。現(xiàn)以農(nóng)電平臺(tái)1.0的目錄結(jié)構(gòu)舉例如下根目錄 一級(jí)目錄二級(jí)目錄 三級(jí)目錄 對(duì)應(yīng)配置項(xiàng)備注 產(chǎn)品名稱 版本號(hào) 核心jar源碼 存目錄前正在修改一體化平源碼的內(nèi)容Class臺(tái) 包 文件 擴(kuò)展源碼包 源碼sql SQL文件 源碼F 版本變動(dòng)說(shuō)明 需求文檔 用戶需求記版本號(hào)在文件

5、名上錄標(biāo)識(shí)概要設(shè)計(jì)文檔總體設(shè)計(jì)文按版本號(hào)依次類推檔數(shù)據(jù)庫(kù)設(shè)計(jì)文檔G詳細(xì)設(shè)計(jì)文檔測(cè)試用例測(cè)試記錄版本 號(hào)在文件名上標(biāo)識(shí)用戶手冊(cè)用戶使用手冊(cè)產(chǎn)品說(shuō)明書 項(xiàng)目計(jì)劃 項(xiàng)目計(jì)劃 實(shí)施手冊(cè) 實(shí)施手冊(cè) 月度計(jì)劃 月度計(jì) 劃 安裝盤REL_SRC 產(chǎn)品盤 或發(fā)布文檔 H SETUP發(fā)布文 檔表示正式版本及特殊版本的目錄按以下原則定義1正始版本以“V開(kāi)頭，版本號(hào)放后，主版本號(hào)和次主版本號(hào)之 間的“.”去掉，明細(xì)版本號(hào)之前加-1舉例如下 版本號(hào) 目錄名 V1.0 V1.0 V1.1 V1.1 V1.0.1 V1.0.1 V1.1.2 V1.1.2 23文檔的存放 2.3.1當(dāng)前版本和歷史 版本的存放 對(duì)于源碼文件

6、，特別增加了一個(gè)Current目錄，存放當(dāng)前正在開(kāi)發(fā)與維護(hù)的源碼文件，當(dāng)前未發(fā)布版本的所 有數(shù)據(jù)都存放在下。一旦當(dāng)前版本正式發(fā)行，則當(dāng)前目錄被修改為相應(yīng)的歷史目錄。歷史版本是指已經(jīng)發(fā)行的版本，存放在相應(yīng)的版本目錄 之下，一般不允許改動(dòng)。2.3.2 開(kāi)發(fā)文檔的存放 根據(jù)各項(xiàng)目部自己的情況，將系 統(tǒng)用戶需求記錄、總體設(shè)計(jì)文檔、詳細(xì)設(shè)計(jì)及數(shù)據(jù)結(jié)構(gòu)文件、 測(cè)試記錄、用戶手冊(cè)等放入相應(yīng)的目錄下。2.3.3 源代碼的存放 源代碼包括如java, jsp, BMP , ICO 等相關(guān)文件，是未經(jīng)編譯處理的、不能直接交付使用的產(chǎn)品 文件以及編譯產(chǎn)品所需的文件 ；聯(lián)機(jī)幫助文件 HLP在未生成 HLP文件之前的D

7、OC , RTF等格式的文檔也視為源代碼。各子系統(tǒng)當(dāng)前的程序源文件放入相應(yīng)的目錄下。對(duì)于一個(gè)子系統(tǒng)又分多個(gè)分子系統(tǒng)的情況，應(yīng)在該目錄 下分別建立幾個(gè)相應(yīng)的目錄。2.3.4 SQL語(yǔ)句的存放各子系統(tǒng)SQL文件放 入.SQL下，對(duì)于不同的數(shù)據(jù)庫(kù)，分別建立不同的子目 錄，如 oracle、sysbasa db2 等。公共SQL文件直接放入SQL下即可，不同數(shù)據(jù)庫(kù)的特殊 SQL分別放入對(duì)應(yīng)的子目錄下。2.3.5 發(fā)行文檔的存放 發(fā)行文檔是指產(chǎn)品交付用戶使用 所必須的文件。包括產(chǎn)品可執(zhí)行文件，用戶使用說(shuō)明書，聯(lián)機(jī)幫助HLP;資源文件BMP, ICO等，環(huán)境配置文件等。以上文檔作為制作發(fā)行盤的素材，放在R

8、ELEASE的REL_SRC目錄之下，制作好的發(fā)行盤放在RELEASE 的SETUP目錄。24權(quán)限控制管理 為保障文檔的安全性，一致性，以及 防止意外修改，必須對(duì)不同的文檔設(shè)置不同的訪問(wèn)權(quán)限。文檔權(quán)限類別只讀權(quán)限，讀寫權(quán)限。文檔類別設(shè)計(jì)文檔，源碼，發(fā)行文檔。用戶類別開(kāi)發(fā)人員、測(cè)試人員、分析設(shè)計(jì)人員、項(xiàng)目經(jīng) 理、配置管理員、安裝盤制作人員、問(wèn)題及需求管理人員、 用戶文檔編寫人員等。為了控制不同的使用權(quán)限，根據(jù)要求在服務(wù)器上分別建 立不同的用戶，針對(duì)不同的配置項(xiàng)所在目錄分配不同的權(quán) 限。為了便于管理，應(yīng)以表格的形式列由人員與管理對(duì)象的 訪問(wèn)關(guān)系用戶權(quán)限清單。3更新管理版本升級(jí) 3.1版本升級(jí)原則版

9、本升級(jí)應(yīng)嚴(yán) 格納入版本管理的控制之下。應(yīng)當(dāng)謹(jǐn)慎地控制版本的升級(jí)，保障高版本的向下兼容性， 或提供嚴(yán)格定義的升級(jí)方法。在下面幾種情況下，進(jìn)行版本演化和升級(jí)1、當(dāng)產(chǎn)品發(fā)生重大修改和改進(jìn)時(shí)，主版本號(hào)加1。重大修改和改進(jìn)包括 1平臺(tái)遷移；2開(kāi)發(fā)工具的遷移；3體 系結(jié)構(gòu)的變遷。2、當(dāng)產(chǎn)品發(fā)生較小的改進(jìn)或修改時(shí)，次版本號(hào)可以加1。3、對(duì)于改動(dòng)量比較少的，如修改產(chǎn)品的錯(cuò)誤，可增加 內(nèi)部版本號(hào)。內(nèi)部版本號(hào)對(duì)用戶來(lái)說(shuō)是不可見(jiàn)的，只對(duì)項(xiàng)目部?jī)?nèi)部版 本控制有用。4、記錄版本升級(jí)過(guò)程。每次版本升級(jí)，都要填寫版本升級(jí)記錄表，記錄表樣例如下版本升級(jí)記錄表版本號(hào)發(fā)布日期修改文件問(wèn)題簡(jiǎn) 要描述 發(fā)布責(zé)任人 批準(zhǔn)人 備注說(shuō)明

10、版本號(hào) 記錄當(dāng)前 發(fā)布的版本。發(fā)布日期該版本批準(zhǔn)發(fā)布的日期。修改文件版本修改記錄文件，一般為版本修改日志。3.2新版本的發(fā)布 新版本的發(fā)布包括主版本號(hào)和次版本號(hào)的升級(jí)，一般不包括內(nèi)部版本號(hào)的升級(jí)。流程如下1、根據(jù)項(xiàng)目進(jìn)展情況，或者根據(jù)用戶需要進(jìn) 行發(fā)布準(zhǔn)備。2、在指定目錄中，根據(jù)本次發(fā)布的版本號(hào)建立相應(yīng)的 子目錄，將current下的所 有內(nèi)容拷貝至新建目錄下。3、可在新建目錄下建立 readme.txt,并加入相應(yīng)的內(nèi)容。readme.txt文件是記錄該版本與上一版本的不同，作過(guò) 哪些改動(dòng)。格式樣例如下增加或修改功能 涉及源文件改動(dòng)原因 4備份管理為了保證文檔的最大可恢復(fù)性，要隨時(shí)及定期地

11、進(jìn)行備份工作。1、隨時(shí)備份1開(kāi)發(fā)人員每天都要將自已當(dāng)日修改的源 文件在本地機(jī)器上進(jìn)行備份。2開(kāi)發(fā)負(fù)責(zé)人每天要將所有源文件在本地機(jī)備份。3建議備份采用循環(huán)備份。2、定期備份1備份形式為硬盤備份和光盤備份。硬盤備份時(shí)，要備份在獨(dú)立的硬盤上；光盤備份時(shí)，要將 光盤存放在可靠的地方。2備份周期視各產(chǎn)品部、事業(yè)部的具體情況而定。如果處于開(kāi)發(fā)階段，每周應(yīng)對(duì)所有的源程序項(xiàng)進(jìn)行備份，一般為每周周五；如果處于其它階段，根據(jù)具體情況而定，但周期不能超過(guò)兩周。3備份要由版本管理員負(fù)責(zé)，備份原則應(yīng)是保證文檔的 最大可恢復(fù)性。4對(duì)于歷史版本或莫用戶的特殊版本，如果無(wú)特殊原因 不再進(jìn)行修改的話，建議用光盤進(jìn)行備份，而且應(yīng)

12、有備份盤說(shuō)明文件 BACKUP.TXT 。該文件 應(yīng)該記錄以下內(nèi)容本次備份時(shí)間，備份內(nèi)容，執(zhí) 行人。5用戶版本管理 目前主要以做項(xiàng)目為主， 是根據(jù)客戶要求開(kāi)發(fā)的程序。為了更好地管理源程序，應(yīng)為每一用戶建立一個(gè)用戶版 本文件，該文件應(yīng)包含以下內(nèi)容用戶編號(hào) 用戶名稱 軟件版本號(hào) 開(kāi)始使用時(shí)間 聯(lián)系人 聯(lián)系電話 用戶程序更改日 志樣例如下更改版本號(hào)修改模變更原因 變更概述軟件 位置 變更備注 時(shí)間 塊名稱 人員 說(shuō)明1用戶購(gòu)買軟件 時(shí)要為該用戶建立一個(gè)包含上述內(nèi)容的一個(gè)用戶版本文件， 并填寫有關(guān)數(shù)據(jù)。2用戶進(jìn)行版本更新時(shí)要求填寫該文件的版本變更記 錄，用以反映用戶版本的變更情況。6研發(fā)部統(tǒng)一管理階段

13、性版本6.1階段性版本的提交到研發(fā)部 當(dāng)各項(xiàng)目組更新了新版本以后，如果次版本號(hào)發(fā)生 改變，各項(xiàng)目組配置管理員經(jīng)項(xiàng)目經(jīng)理批準(zhǔn)后要把次版本修 改的內(nèi)容提交的內(nèi)容分為修改的源碼、新的文檔和安裝盤提 交給研發(fā)部版本管理人員。6.2 階段性版本的發(fā)布到公司網(wǎng)站上產(chǎn)品新版本發(fā)布以后，及時(shí)在軟件演示環(huán)境中進(jìn)行更新。并且新版本的特色和特點(diǎn)要在公司網(wǎng)站上進(jìn)行發(fā)布，描 述新版本特色的文檔要由各項(xiàng)目組進(jìn)行提供給項(xiàng)目部，經(jīng)項(xiàng) 目部保存后，文檔提交給公司網(wǎng)站管理人員進(jìn)行發(fā)布，以便 供其他項(xiàng)目組和公司營(yíng)銷人員進(jìn)行了解。6.3 各項(xiàng)目組新版本內(nèi)部及時(shí)備份。研發(fā)部負(fù)責(zé)進(jìn)行所有產(chǎn)品版本的管理，但各個(gè)項(xiàng)目組也 要自己進(jìn)行備份。7

14、版本工具的使用 7.1研發(fā)部采用svn配置管理工具研 發(fā)部采用專門的配置管理服務(wù)器，此服務(wù)器只是專門用于版 本的管理，一般不用于其他的應(yīng)用，配置管理軟件采用 svn1.5 進(jìn)行配置管理。8各項(xiàng)目組提交文檔及源碼以及規(guī)則8.1各項(xiàng)目組需要提交的文檔 名稱 成果描述 立項(xiàng)申請(qǐng)書 寫名此項(xiàng)目的價(jià) 值、所需人力資源及費(fèi)用、可行性分析、成本-效益分析、風(fēng)險(xiǎn)分析立項(xiàng)評(píng)審報(bào)告評(píng)審結(jié)論、評(píng)審建議軟件需求說(shuō)明書 目標(biāo)客戶、業(yè)務(wù)流程、系統(tǒng)中的角色、子功能模塊介 紹、質(zhì)量要求、界面要求 系統(tǒng)設(shè)計(jì)說(shuō)明書 系統(tǒng)約束、開(kāi) 發(fā)環(huán)境、數(shù)據(jù)流程圖、用例圖、模塊之間的關(guān)系圖、類函數(shù)文件變量等命名規(guī)則、系統(tǒng)安全設(shè)計(jì)說(shuō)明、性能分析數(shù)

15、據(jù)庫(kù)設(shè)計(jì)說(shuō)明書 所有表名、表設(shè)計(jì)、表ER圖、生成庫(kù)的sql 語(yǔ)句、存儲(chǔ)過(guò)程等。表及字段命名規(guī)則。用戶界面設(shè)計(jì)說(shuō)明書 系統(tǒng)界面設(shè)計(jì)說(shuō)明、原型圖 模塊 設(shè)計(jì)說(shuō)明書 編程的接口、主要的數(shù)據(jù)結(jié)構(gòu)、主要算法 測(cè)試 用例用例名稱、用例描述、輸入值、希望輸由值缺陷報(bào)告Bug名稱、bug狀態(tài)、bug緊急情況、bug處理人等測(cè)試報(bào)告 界面測(cè)試報(bào)告、性能測(cè)試報(bào)告部署說(shuō)明書 部署環(huán)境說(shuō)明、初始化的數(shù)據(jù)、注意事項(xiàng)、數(shù)據(jù)的遷移等安裝和使用手冊(cè) 安裝過(guò)程描述、各模塊使用手冊(cè)、FAQ手冊(cè) 軟件源代碼 源代碼、開(kāi)發(fā)工具、API詳細(xì)說(shuō)明、代碼注釋、編譯后程 序系統(tǒng)維護(hù)記錄 問(wèn)題描述、問(wèn)題解決情況技術(shù)評(píng)審報(bào)告評(píng)審內(nèi)容、評(píng)審結(jié)果、

16、評(píng)審人系統(tǒng)安裝程序 打包程序、打包工具、打包完以后的安裝程序8.2目前所管理的產(chǎn)品列表序列號(hào)產(chǎn)品名稱應(yīng)用范圍所屬項(xiàng)目組產(chǎn)品介紹1 一體 化平臺(tái)Sg186農(nóng)電 農(nóng)電2安全性評(píng)價(jià)系統(tǒng) 電網(wǎng)安全性調(diào) 度 評(píng)價(jià)3電網(wǎng)調(diào)度專業(yè)技術(shù)電網(wǎng)調(diào)度 安全知識(shí)在線調(diào)考 系統(tǒng)網(wǎng)省版 4電網(wǎng)現(xiàn)場(chǎng)標(biāo)準(zhǔn)化作電網(wǎng)調(diào)度 業(yè)系統(tǒng)5國(guó)調(diào)E語(yǔ)言編輯瀏電網(wǎng) 調(diào)度 覽器6江西省電力公司生電 網(wǎng) 調(diào)度 產(chǎn)安全管理系統(tǒng) 7江西省電力公司電電網(wǎng)調(diào)度網(wǎng)輸電GIS 8青海一體化OMS項(xiàng)電網(wǎng) 調(diào)度 目建設(shè)9生產(chǎn) 管理系統(tǒng)短信電網(wǎng) 調(diào)度 平臺(tái)10泰豪EOMP業(yè)務(wù)基電網(wǎng) 調(diào)度 礎(chǔ)平臺(tái)11泰豪圖形化智能操電網(wǎng)調(diào)度 作票系統(tǒng)9周報(bào)管理制度 各項(xiàng)目組每周向研發(fā)部提交周報(bào)。周報(bào)具體的格式如下 項(xiàng)目周報(bào) 報(bào)告名稱 所屬項(xiàng)目 報(bào) 告人報(bào)告日期1.任務(wù)進(jìn)度情況 本周工作匯報(bào)