程序代码版本本管理规范.docx
.
软件版本管理规范
Software
Approved by:Checked by:Prepared by:
.
Revision List
Date Description Revision Owner
.
目录
一、目的 ..................................................................................- 4 -
二、适用范围 ...............................................................................- 4 -
三、版本定义规范 . ..........................................................................- 4 -
四、版本代码设计规范 . ......................................................................- 5 -
五、版本进阶规范 . ..........................................................................- 5 -
六、软件备份要求规范 . ......................................................................- 6 -
七、软件版本发布规范 . ......................................................................- 6 -
八、软件发布流程规范 . ......................................................................- 8 -
九、量产中软件管理规范 . ....................................................................- 9 -
.
一、目的
1.1 本规范规定了公司软件发布及版本管理规范,为工程师发布软件提供版本管理标准和流
程。
1.2 提高本公司软件版本的可识别性,为工程,生产,售后服务提供便利性。
二、适用范围
本规范适用于研发部软件人员发布软件、程序时制定版本参考。
本规范中所涉及软件为泛指一切以计算机代码形式存在的软件,包括以下( 但不限于 ) 几类:
1、 Windows 软件、程序
2、 Linux软件、程序
3、经过裁剪后 Linux内核
4、单片机, DSP,ARM固件代码及烧录FW
5、 FPGA代码及烧录 FW
6、本公司自己开发的驱动程序
7、第三方提供的驱动程序
8、第三方提供的烧录FW
三、版本定义规范
3.1 本规范规定:除第三方提供的软件以外,本公司开发的软件正式版本号采用如下格式,
3.1.1三位版本编码格式,即x.xx,由三位数字和一位小数点组成。
第一版正式版即 1.00 ;
3.2用哪种版本号格式由件自身情况决定;同一件版本号格式不得随意更改, 一旦用三位或五位版本格式,在没有必要和充分的理由的前提下不能版本号格式行更。
3.3第三方公司提供的件沿用第三方公司的版本号格式。
四、版本代码设计规范
便于和看件版本,固件、件版本通工具可以被看,因此在件代段,
版本看如下要求:
4.1 固件:量后的F/W版本可通以下两种方式之一行看
(1)可以通 LCD示。
(2)可用通串口或其他通信接口通上位机件(命令方式)取
4.2 上位机程序或件版本可以通以下方式之一行看
(1)示在、状,或界面中;
(2)通“关于?”或“ About?”菜看;
(3)通命令行看。例: xxxx – h 或 xxxx – ver ;
五、版本进阶规范
5.1 正式版版本迭代更新。件修正bug,完善功能,增加功能的情况下,需要件版本
行更新和升,本范定如下:
5.1.1 三位版本格式
正式版本迭代升可行两部分更,小数位之前或小数位之后。
例: 1.00 版本可以升 1.01 ,也可以升 2.00 ;
5.2测试版和试用版版本迭代更新。
产品量产后若需要修改部分功能或针对客户进行定制的F/W 和 Program 在测试验证阶段均采用 5 位数字和 2 个小数点构成,且只能修改最后两位数字版本号,如:
1.01.00-。只有当测试版本经过测试和验证,或客户认可后,才能发
表正式版,进阶前 3 位数字。例: 1.01.02的测试版解决了某些bug 或增加功能,并经过测试验证解决了实际的问题,则将 1.01.02 测试版重新编译,变更测试版本变更为正式版
格式。如 1.01.02-->1.02.00。
六、软件备份要求规范
软件代码变更后均要将变更更新至服务器Git 版本库进行管理,未备份至 Git 版本库的软件版本不允许发布。
具体备份步骤参考《研发部Git 版本库服务器使用指南》。
七、软件版本发布规范
7.1 正式版 FW,软件需要经过工程测试部门验证后在进行发布。测试版软件发布由工程师根据
实际情况而定。
7.2 正式版软件发布时要除软件本身外,需要附更新说明release notes。
Release notes采用追加方式记录,即保留之前的更新日志。且采用倒序方式,最新版本更新
日志在最前端。测试版更新一样要记录入更新日志文件。
Release notes格式如下:
Author :
更新原因及内容:
(1)Xxxxx
(2)Xxxxx
---------(分隔) --------
前一版本: 1.00.08(T版)日期: xx-xx-xx
Author :
更新原因及内容:
(1)Xxxxx
(2)Xxxxx
????????
八、软件发布流程规范
软件工程师代
码编写、修改
设计工程师
调试
No
调试通过?
Yes Yes
测试版本
Git 代码库
发布
测试工程师测
试验证
验证通过?
反馈给软No件工程师
更新
Yes
客户验证
(Option )
No
验证通过?
Yes
软件工程师发布发布 ECN通知工程、生产,正式版计划做相应变更
九、量产中软件管理规范
9.1已发布的软件程序,安装包,Bin ,Hex 等文件需要在 FTP中进行备份。备份管理工作由工程部负责。
9.2生产部生产带有软件下载的PCBA或成品时, F/W(bin,hex) 文件下载后须在相应芯片上贴上“机种、版本”标签。
9.3 当软件版本有更新时,软件工程师和研发主管根据更新内容评估,对在产品,产成品,及
已出货产品中的软件是否更新,其他部门应根据ECN要求执行更新动作。
9.4 对已更新软件版本的产品,需要更换正确的,与之对应的标签;已出货的产品视具体情况
而定。
9.5 QA 应对出货及入库产品的软件版本进行检查。检查方法由工程部或研发部提供。
单纯的课本内容,并不能满足学生的需要,通过补充,达到内容的完善
教育之通病是教用脑的人不用手,不教用手的人用脑,所以一无所能。教育革命的对策是手脑联盟,结果是手与脑的力量都可以大到不可思议。