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

1、Working InstructionDocument No.:Rev.Modify Date:Page:- 8 - of -8-軟件版本管理規(guī)范Approved by:Checked by:Prepared by:Software- 8 -Revision ListDateDescriptionRevisionOwner目錄一、目的- 4 -二、適用范圍- 4 -三、版本定義規(guī)范- 4 -四、版本代碼設計規(guī)范- 4 -五、版本進階規(guī)范- 5 -六、軟件備份要求規(guī)范- 5 -七、軟件版本發(fā)布規(guī)范- 5 -八、軟件發(fā)布流程規(guī)范- 7 -九、量產中軟件管理規(guī)范- 8 -一、目的1.1本規(guī)范規(guī)定了公

2、司軟件發(fā)布及版本管理規(guī)范，為工程師發(fā)布軟件提供版本管理標準和流程。1.2提高本公司軟件版本的可識別性，為工程，生產，售后服務提供便利性。二、適用范圍本規(guī)范適用于研發(fā)部軟件人員發(fā)布軟件、程序時制定版本參考。本規(guī)范中所涉及軟件為泛指一切以計算機代碼形式存在的軟件，包括以下(但不限于)幾類：1、 Windows 軟件、程序2、 Linux 軟件、程序3、 經過裁剪后Linux 內核4、 單片機，DSP，ARM 固件代碼及燒錄FW5、 FPGA 代碼及燒錄FW6、 本公司自己開發(fā)的驅動程序7、 第三方提供的驅動程序8、 第三方提供的燒錄FW三、版本定義規(guī)范3.1本規(guī)范規(guī)定：除第三方提供的軟件以外，本公

3、司開發(fā)的軟件正式版本號采用如下格式，3.1.1 三位版本編碼格式，即x.xx, 由三位數字和一位小數點組成。第一版正式版即1.00；在1.00正式版之前研發(fā)內部測試和驗證版本以0.xx.xx 表示。3.2 選用哪種版本號格式由軟件自身情況決定；同一軟件版本號格式不得隨意更改,一旦選用三位或五位版本編碼格式，在沒有必要和充分的理由的前提下不能對版本號格式進行變更。 3.3 第三方公司提供的軟件繼續(xù)沿用第三方公司的版本號編碼格式。四、版本代碼設計規(guī)范 為便于檢查和查看軟件版本，固件、軟件版本通過工具可以被查看，因此在軟件代碼設計階段，對版本查看應實現如下要求：4.1固件：量產后燒錄的F/W版本可通

4、過以下兩種方式之一進行查看(1) 可以通過LCD顯示。(2) 可用通過串口或其他通信接口通過電腦上位機軟件（命令方式）獲取4.2上位機程序或軟件版本可以通過以下方式之一進行查看(1) 顯示在標題欄、狀態(tài)欄，或界面中；(2) 通過“關于”或 “About”菜單查看；(3) 通過命令行查看。例： xxxx h 或 xxxx ver；五、版本進階規(guī)范5.1正式版版本迭代更新。軟件為修正bug，完善功能，增加功能的情況下，需要對軟件版本進行更新和升級，本規(guī)范規(guī)定如下：5.1.1三位版本編碼格式正式版本迭代升級可進行兩部分變更，小數位之前或小數位之后。例：1.00 版本可以升級為 1.01，也可以升級為

5、2.00；較大的軟件變動建議升級小數位之前數字，較小的軟件修正和變動建議升級小數位之后的數字。5.2 測試版和試用版版本迭代更新。產品量產后若需要修改部分功能或針對客戶進行定制的F/W和Program在測試驗證階段均采用5位數字和2個小數點構成， 且只能修改最后兩位數字版本號，如：1.01.00-à1.01.01,1.01.02。 只有當測試版本經過測試和驗證，或客戶認可后，才能發(fā)表正式版，進階前3位數字。例： 1.01.02的測試版解決了某些bug或增加功能，并經過測試驗證解決了實際的問題，則將1.01.02測試版重新編譯，變更測試版本變更為正式版格式。如 1.01.02->

6、1.02.00。六、軟件備份要求規(guī)范軟件代碼變更后均要將變更更新至服務器Git版本庫進行管理，未備份至Git版本庫的軟件版本不允許發(fā)布。具體備份步驟參考研發(fā)部Git版本庫服務器使用指南。七、軟件版本發(fā)布規(guī)范7.1正式版FW，軟件需要經過工程測試部門驗證后在進行發(fā)布。測試版軟件發(fā)布由工程師根據實際情況而定。7.2正式版軟件發(fā)布時要除軟件本身外，需要附更新說明release notes。Release notes 采用追加方式記錄，即保留之前的更新日志。且采用倒序方式，最新版本更新日志在最前端。測試版更新一樣要記錄入更新日志文件。Release notes 格式如下：當前版本：1.01日期：xx-xx-xxAuthor：更新原因及內容：(1)Xxxxx(2)Xxxxx-（分隔線）-前一版本：1.00.08(T測試版)日期：xx-xx-xxAuthor：更新原因及內容：(1)Xxxxx(2)Xxxxx八、軟件發(fā)布流程規(guī)范九、量產中軟件管理規(guī)范9.1 已發(fā)布的軟件程序，安裝包，Bin，Hex等文件需要在FTP中進行備份。 備份管理工作由工程部負責。9.2 生產部生產帶有軟件下載的PCBA或成品時，F/W(bin,hex)文件下載后須在相應芯片上貼上“機種、版本”標簽。9.3當軟件版本有更新時，軟件工程師和研發(fā)主管根據更新內容評估，對在產品，產成品，及已出貨產品中的軟件