一、计划目标​

为确保电商系统开发过程中所有​​代码、文档、配置项及版本变更​​的可控性、一致性和可追溯性,本计划定义配置管理流程、角色职责、工具使用及基线控制规则,保障项目交付成果的完整性与可靠性。


​二、适用范围​

覆盖电商系统建设项目全生命周期(需求→设计→开发→测试→部署)中产生的​​所有配置项(CI)​​,包括:

  • ​代码类​​:前端代码(Vue/React)、后端代码(Java/Spring Cloud)、移动端代码(Flutter/React Native)、数据库脚本、配置文件(如Nginx/Redis配置)。

  • ​文档类​​:需求规格说明书、系统设计文档(架构/数据库/接口)、测试用例与报告、用户操作手册、部署手册。

  • ​环境类​​:开发/测试/生产环境的服务器配置参数、第三方服务API密钥(脱敏后)、容器化配置(如Dockerfile/K8s YAML)。


​三、核心概念定义​

3.1 配置项(Configuration Item, CI)

项目中需被版本控制与变更管理的最小单元,例如:

  • 代码文件(如src/order-service/api/user.js);

  • 文档(如《需求规格说明书_V1.2.docx》);

  • 配置文件(如application-prod.yml)。

3.2 基线(Baseline)

经过正式评审并冻结的配置项集合,作为后续开发的基准。本项目定义三类基线:

  • ​需求基线​​:需求规格说明书通过评审后冻结(第2个月末);

  • ​设计基线​​:系统架构/数据库/接口设计通过评审后冻结(第3个月末);

  • ​发布基线​​:测试通过后准备上线的代码与文档集合(第6个月末)。

3.3 版本号规则(语义化版本)

代码与文档版本格式:主版本号.次版本号.修订号(如1.2.3),规则如下:

  • ​主版本号​​:重大功能变更或架构调整(如新增支付模块);

  • ​次版本号​​:新增功能或模块优化(如订单状态新增“拼团中”);

  • ​修订号​​:Bug修复或文档错别字修正(如修复支付接口超时问题)。


​四、角色与职责​

​角色​

​职责​

​配置管理员(CMO)​

负责配置管理工具维护、基线建立与发布、版本权限控制、变更流程审核(最终批准)。

​项目经理​

审批基线建立与重大变更请求(影响范围≥2个模块),监控配置管理执行合规性。

​开发/测试人员​

提交代码/文档变更请求(CR),遵循版本控制规范(如分支管理),配合基线评审。

​SQA工程师​

监督配置管理流程执行(如是否漏提变更、版本记录是否完整),输出审计报告。


​五、配置管理流程​

5.1 配置项识别与登记

  • ​识别范围​​:所有代码、文档、环境配置均需登记为配置项,通过《配置项清单》明确名称、类型(代码/文档/环境)、负责人、存储位置(如Git仓库路径)。

  • ​登记要求​​:每个配置项需唯一标识(如CI-001-订单服务后端代码),并在首次纳入管理时由CMO录入配置管理数据库(CMDB)。

5.2 版本控制规则

  • ​代码版本控制​​:使用Git(推荐GitLab/GitHub),分支策略如下:

    • ​主分支(main/master)​​:仅存放发布基线代码(禁止直接提交),对应线上生产环境。

    • ​开发分支(dev)​​:集成所有功能开发分支的代码,用于日常集成测试。

    • ​功能分支(feature/xxx)​​:每个新功能或Bug修复独立创建分支(如feature/user-login),开发完成后合并至dev

    • ​修复分支(hotfix/xxx)​​:线上紧急Bug修复时从main拉取,修复后合并至maindev

  • ​文档版本控制​​:文档存放在Git仓库的docs/目录,或通过Confluence/Wiki管理,每次修改需更新版本号并记录变更内容(如“V1.1:新增支付接口字段说明”)。

5.3 基线建立与发布

  • ​基线触发条件​​:需求/设计/发布阶段结束时,由项目经理发起基线评审申请,CMO组织相关人员(产品/开发/测试)评审通过后冻结配置项集合,形成基线。

  • ​基线存储​​:基线代码打标签(如baseline-需求基线-V1.0),文档归档至指定目录(如/archives/需求基线/),并记录基线包含的配置项清单及版本号。

5.4 变更控制流程

  • ​变更请求(CR)​​:任何对配置项的修改(如代码逻辑调整、文档内容更新)需提交《变更请求表》,包含变更原因、影响范围(如关联模块)、预期收益、实施人。

  • ​变更评审​​:

    • 小变更(如文档错别字修正、代码注释调整):由开发负责人直接批准。

    • 大变更(如核心功能逻辑调整、影响≥2个模块):需经项目经理+CMO+受影响角色(如测试)评审,通过后由CMO更新版本号并记录。

  • ​变更实施​​:批准后的变更由指定人员在独立分支开发,测试通过后合并至主分支,并更新基线(如需)。


​六、工具与技术​

​工具类型​

​工具名称​

​用途​

​版本控制工具​

Git(GitLab/GitHub)

管理代码与文档版本,支持分支/合并/标签功能。

​配置管理数据库​

CMDB(自定义表格/Redmine)

记录所有配置项的详细信息(名称、类型、负责人、版本号、存储位置、关联基线)。

​文档协作工具​

Confluence/Wiki

管理非代码文档(需求/设计/测试用例),支持版本历史查看。

​变更管理工具​

Jira(或Excel表)

跟踪变更请求(CR)的提交、评审、批准与实施状态。


​七、基线与版本示例​

7.1 基线清单(示例)

​基线名称​

​触发阶段​

​包含配置项​

​版本号/标签​

​评审通过时间​

需求基线

需求分析完成

《需求规格说明书》《用户故事清单》

V1.0(文档)、baseline-需求基线-V1.0(标签)

第2个月末

设计基线

系统设计完成

架构图/数据库ER图/接口文档

V1.0(文档)、baseline-设计基线-V1.0(标签)

第3个月末

发布基线

测试通过

上线代码(前端/后端/移动端)+部署手册

V1.0(代码)、baseline-发布基线-V1.0(标签)

第6个月末

7.2 版本号示例

  • 代码:用户登录模块接口从1.0.01.1.0(新增“短信验证码登录”功能)→1.1.1(修复验证码过期时间Bug)。

  • 文档:《订单管理功能测试用例》从V1.0V1.1(补充“拼团订单”测试场景)。


​八、监控与审计​

  • ​日常监控​​:CMO每周检查配置项版本记录(如Git提交日志)、变更请求处理状态,确保无漏控变更。

  • ​定期审计​​:SQA每月抽查配置项的版本一致性(如代码与文档是否匹配)、基线完整性(如标签是否关联所有配置项),输出《配置管理审计报告》。

  • ​问题处理​​:若发现配置项丢失或版本冲突(如代码覆盖),CMO需立即回滚至最近稳定版本,并追溯责任。


​九、附录​

  • 附录1:《配置项清单模板》(含CI编号、名称、类型、负责人、版本号、存储路径)。

  • 附录2:《变更请求表模板》(含CR编号、变更内容、影响范围、评审人、状态)。

  • 附录3:《基线评审记录表模板》(含基线名称、参与评审角色、通过结论、签字)。

​编制人​​:配置管理员(李四) & 项目经理(张三)

​版本号​​:V1.0

​发布日期​​:202X年X月X日

(注:可根据项目实际工具链(如用SVN替代Git)调整流程细节。)

Logo

开源鸿蒙跨平台开发社区汇聚开发者与厂商,共建“一次开发,多端部署”的开源生态,致力于降低跨端开发门槛,推动万物智联创新。

更多推荐