编号是团队协作的通用语言。统一编号让沟通、追踪、归档零歧义。使用此规则时,所有编号必须遵循以下体系。
所有编号的分段式结构:
[项目标识]-[对象类型]-[模块/分类]-[序号]-[版本/后缀]
分隔符:段间用 -,WBS层级用 .,字母全大写,不含空格。
| 缩写 | 含义 |
|---|---|
| ------ | ------ |
| REQ | 需求 |
| TSK | 任务 |
| BUG | 缺陷 |
| VER | 版本 |
| DOC | 文档 |
| ADR | 架构决策记录 |
| API | 接口 |
| ENV | 环境 |
| CFG | 配置 |
[项目标识]-REQ-[模块编号]-[序号]
模块编号在项目启动时定义,全局唯一。常见映射:01-用户、02-订单、03-商品、04-消息、05-数据、06-基础架构、07-运营、08-第三方集成、99-其他。
示例:UMS-REQ-01-001 = 用户管理系统-需求-用户模块-第1条
需求变更:原编号不变,末尾追加 -V[版本号]。V1为原始版本,每次正式变更递增。评审会上的小调整不递增。
示例:UMS-REQ-01-001-V1 → UMS-REQ-01-001-V2
优先级不在编号中体现,用标签:S(Must Have)、A(Should Have)、B(Nice to Have)、C(Won't Have)。
需求驱动的任务,从需求拆解:
[需求编号].T[子任务序号]
示例:UMS-REQ-01-001.T1、UMS-REQ-01-001.T2
非需求驱动的任务(技术债、重构、基础设施):
[项目标识]-TSK-[模块编号]-[序号]
示例:UMS-TSK-06-001
[项目标识]-BUG-[模块编号]-[序号]
示例:UMS-BUG-01-042
严重等级和来源(PROD/UAT/SIT/DEV)不在编号中,用标签。Bug可关联需求:PAY-BUG-02-018 → PAY-REQ-02-015。
语义化版本号:
V[主版本号].[次版本号].[修订号]
递增规则:次版本号递增时修订号归零;主版本号递增时次版本号和修订号都归零。
阶段后缀:-alpha.N(内测)、-beta.N(公测)、-rc.N(候选)、无后缀(正式)。
内部构建号:V1.3.0+build.127,CI自动生成,禁止手工修改。
[项目标识]-DOC-[文档类型]-[序号]-V[版本号]-[日期]
文档类型缩写:
| 缩写 | 含义 |
|---|---|
| ------ | ------ |
| PRD | 产品需求文档 |
| SRS | 软件需求规格 |
| TSD | 技术方案文档 |
| API | 接口文档 |
| TPL | 测试计划 |
| TCR | 测试用例与报告 |
| DP | 部署方案 |
| MM | 会议纪要 |
| RM | 复盘纪要 |
| OP | 运维手册 |
| UR | 用户手册 |
示例:UMS-DOC-PRD-001-V1.0-20260518
文档版本更新:小修改(措辞、格式)修订号+1;大修改(核心内容变更、章节增删)次版本号+1。
文件命名:[文档编号]_[文档简称].md,如 UMS-DOC-PRD-001-V1.0-20260518_用户注册需求.md
[项目标识]-ADR-[序号]
示例:UMS-ADR-001
每个ADR包含:状态(已提议/已接受/已废弃/已替代)、日期、决策者、背景、决策、备选方案、影响。
URL路径版本:/api/v[主版本号]/[资源路径]
向后兼容的变更(新增字段、新增可选参数、新增接口)不需要新版本。不兼容变更(删除字段、修改字段类型、修改必填参数)必须新版本。
[项目标识]-CFG-[模块编号]-[序号]
示例:UMS-CFG-01-001
配置按环境区分值,编号不变。
[分支类型]/[任务编号]-[简短描述]
分支类型:feature/、bugfix/、hotfix/、release/、tech/
规则:全小写,单词间用 -,描述3~5个单词,必须包含任务编号,禁止用个人姓名。
示例:feature/UMS-REQ-01-001-user-register
[类型]: [任务编号] [简短描述]
类型:feat、fix、refactor、docs、test、chore、perf
规则:必须包含任务编号,描述不超过50字符,现在时态祈使语气,一次提交只做一件事。
需求: [项目]-REQ-[模块]-[序号] 如 UMS-REQ-01-001
任务: [需求编号].T[子任务序号] 如 UMS-REQ-01-001.T2
技术: [项目]-TSK-[模块]-[序号] 如 UMS-TSK-06-001
Bug: [项目]-BUG-[模块]-[序号] 如 UMS-BUG-01-042
版本: V[主].[次].[修订][-后缀] 如 V1.3.0-rc.1
文档: [项目]-DOC-[类型]-[序号]-V[版本]-[日期] 如 UMS-DOC-TSD-001-V1.0-20260518
ADR: [项目]-ADR-[序号] 如 UMS-ADR-001
分支: [类型]/[任务编号]-[描述] 如 feature/UMS-REQ-01-001-user-register
提交: [类型]: [任务编号] [描述] 如 feat: UMS-REQ-01-001 实现注册接口
接口: /api/v[版本]/[资源] 如 /api/v1/users/register
环境: dev / sit / uat / prod
配置: [项目]-CFG-[模块]-[序号] 如 UMS-CFG-01-001
共 1 个版本