程序代碼版本管理規(guī)范解析

1、Document NojRev.Modify Date:Page: 1 - of-a-軟件版本管理規(guī)范SoftwareDocument NojRev.Modify Date:Page:-i - of -8-Document Ns:Rev.Modify Date:Page:-2 -減-乩Revisi on Listnocumcnl Ma-Rev.Mo DilarPvgt-DulcRrvMnOwnerDocument NojRev.Modify Date:Page:-3 - of *8*目錄一、目的-4 -二、適用范圍-4 -、版本定義規(guī)范-4 -四、版本代碼設(shè)計(jì)規(guī)范-4 -五、版本進(jìn)階規(guī)范-5

2、-六、軟件備份要求規(guī)范-5 -七、軟件版本發(fā)布規(guī)范-5 -八、軟件發(fā)布流程規(guī)范-7 -九、量產(chǎn)中軟件管理規(guī)范.-8 -Docuinent Ns:Rev.Modify Date:Page:-4 -減-E一、目的1.1本規(guī)范規(guī)定了公司軟件發(fā)布及版本管理規(guī)范，為工程師發(fā)布軟件提供版本管 理標(biāo)準(zhǔn)和流程。1.2提高本公司軟件版本的可識(shí)別性，為工程，生產(chǎn)，售后服務(wù)提供便利性。二、適用范圍本規(guī)范適用于研發(fā)部軟件人員發(fā)布軟件、程序時(shí)制定版本參考。本規(guī)范中所涉及軟件為泛指一切以計(jì)算機(jī)代碼形式存在的軟件，包括以下（但不限于幾類：1、Windows軟件、程序2、Linux軟件、程序3、經(jīng)過裁剪后Linux內(nèi)核4、單

3、片機(jī),DSP,ARM固件代碼及燒錄FW5、FPGA代碼及燒錄FW6本公司自己開發(fā)的驅(qū)動(dòng)程序7、第三方提供的驅(qū)動(dòng)程序8、第三方提供的燒錄FW三、版本定義規(guī)范3.1本規(guī)范規(guī)定:除第三方提供的軟件以外，本公司開發(fā)的軟件正式版本號(hào)采用如 下格式，3.1.1三位版本編碼格式,即x.xx,由三位數(shù)字和一位小數(shù)點(diǎn)組成第一版正式版即1.00;在1.00正式版之前研發(fā)內(nèi)部測(cè)試和驗(yàn)證版本以0.XX.XX表示。3.2選用哪種版本號(hào)格式由軟件自身情況決定；同一軟件版本號(hào)格式不得隨意更 改,一旦選用三位或五位版本編碼格式，在沒有必要和充分的理由的前提下不能對(duì)版 本號(hào)格式進(jìn)行變更。3.3第三方公司提供的軟件繼續(xù)沿用第三方

4、公司的版本號(hào)編碼格式。四、版本代碼設(shè)計(jì)規(guī)范為便于檢查和查看軟件版本，固件、軟件版本通過工具可以被查看，因此在軟件代碼設(shè)計(jì)階段，Document Nc:Rev.Modify Date：Page:-5 -對(duì)版本查看應(yīng)實(shí)現(xiàn)如下要求4.1固件:量產(chǎn)后燒錄的F/W版本可通過以下兩種方式之一進(jìn)行查看(1可以通過LCD顯示。(2可用通過串口或其他通信接口通過電腦上位機(jī)軟件(命令方式獲取4.2上位機(jī)程序或軟件版本可以通過以下方式之一進(jìn)行查看(1顯示在標(biāo)題欄、狀態(tài)欄，或界面中；(2通過 關(guān)于”或“ About菜單查看；(3通過命令行查看。例：xxxx 或xxxx -/er;五、版本進(jìn)階規(guī)范5.1正式版版本迭代更

5、新。軟件為修正bug,完善功能，增加功能的情況下，需要對(duì)軟件版本進(jìn)行更新和升級(jí)，本規(guī)范規(guī)定如下：5.1.1三位版本編碼格式正式版本迭代升級(jí)可進(jìn)行兩部分變更，小數(shù)位之前或小數(shù)位之后。例:1.00版本可以升級(jí)為1.01也可以升級(jí)為2.00;較大的軟件變動(dòng)建議升級(jí)小數(shù)位之前數(shù)字，較小的軟件修正和變動(dòng)建議升級(jí)小 數(shù)位之后的數(shù)字。5.2測(cè)試版和試用版版本迭代更新。產(chǎn)品量產(chǎn)后若需要修改部分功能或針對(duì)客戶進(jìn)行定制的F/W和Program在測(cè)試驗(yàn)證階段均采用5位數(shù)字和2個(gè)小數(shù)點(diǎn)構(gòu)成，且只能修改最后兩位數(shù)字版本號(hào)，如:1.01.00- 1.01.01,1.01.02只有當(dāng)測(cè)試版本經(jīng)過測(cè)試和驗(yàn)證，或客戶認(rèn)可后，才

6、能 發(fā)表正式版,進(jìn)階前3位數(shù)字。例：1.01.02的測(cè)試版解決了某些bug或增加功能， 并經(jīng)過測(cè)試驗(yàn)證解決了實(shí)際的問題，則將1.01.02測(cè)試版重新編譯，變更測(cè)試版本變更 為正式版格式。如1.01.02-1.02.00b六、軟件備份要求規(guī)范軟件代碼變更后均要將變更更新至服務(wù)器Git版本庫(kù)進(jìn)行管理，未備份至Git版本庫(kù)的軟件版本不允許發(fā)布。具體備份步驟參考研發(fā)部Git版本庫(kù)服務(wù)器使用指南七、軟件版本發(fā)布規(guī)范7.1正式版FW,軟件需要經(jīng)過工程測(cè)試部門驗(yàn)證后在進(jìn)行發(fā)布。測(cè)試版軟件發(fā) 布由工程師根據(jù)實(shí)際情況而定。Document No.: Rev. Working Instruction Modify

7、 Date: Page: - 6 - of -8- 7.2 正式版 軟件發(fā)布時(shí)要除軟件本身外，需要附更新說明release notes Release notes采用追加方式記錄，即保留之前的更新日志。且采用倒序方式，最新版本更新日志在最前端。測(cè)試版更新一樣要記錄入更新日志文件。Release notes格式如下：當(dāng)前版本：1.01 日期：xx-xx-xx Author :更新原因及內(nèi)容：（1Xxxxx （2Xxxxx （分隔線）前一版本：1.00.08（T測(cè)試版日期：xx-xx-xx Author :更新原因及內(nèi)容：（1Xxxxx （2Xxxxx ,-6-Document No.: Rev.

8、 Working Instruction Modify Date: Page: - 7 - of -8-八、軟件 發(fā)布流程規(guī)范軟件工程師代碼編寫、修改設(shè)計(jì)工程師調(diào)試No調(diào)試通過？ Yes Yes測(cè)試版本發(fā)布Git代碼庫(kù)測(cè)試工程師測(cè) 試驗(yàn)證驗(yàn)證通過？ No反饋給軟件工 程師更新Yes客戶驗(yàn)證（Option） No驗(yàn)證通過？ Yes軟件工程師發(fā)布 正式版 發(fā) 布ECN通知工程、生產(chǎn)，計(jì)劃做相應(yīng)變更-7-Document No.: Rev. Working Instruction Modify Date: Page: - 8 - of -8-九、量產(chǎn) 中軟件管理規(guī)范9.1已發(fā)布的軟件程序，安裝包，Bin，Hex等文件需要在FTP中 進(jìn)行備份。備份管理工作由工程部負(fù)責(zé)。9.2生產(chǎn)部生產(chǎn)帶有軟件下載的PCBA 或成品時(shí)，F(xiàn)/W（bin,hex文件下載后須在相應(yīng)芯片上貼 上機(jī)種、版本”標(biāo)簽。9.3 當(dāng)軟件版本有更新時(shí)，軟件工程師和研發(fā)主管根據(jù)更新內(nèi)容評(píng)估，對(duì)在