Files
team/memory/doc-versioning-rules.md
2026-04-19 21:47:08 +08:00

2.0 KiB
Raw Permalink Blame History

name, description, type, originSessionId
name description type originSessionId
文档版本号规则 项目所有 markdown 文档的版本号统一规则,包含版本含义和修改条件 feedback bd3aefbc-d5bd-4d0e-8404-0bae02301ed4

版本号格式

MAJOR.MINOR.PATCH(语义化版本)

各位含义

含义 修改条件 示例
MAJOR 大版本 项目重大重构、文档体系拆分/合并、核心架构变更 v4 → v5
MINOR 小版本 文档内容实质性变更(新增/修改/删除功能需求、架构调整等) v4.0 → v4.1
PATCH 补丁版本 修复错别字、格式调整、术语统一、链接修正 v4.0.0 → v4.0.1

核心规则

  1. 大版本按需独立: 当文档发生重大重构(拆分/合并/核心架构变更)时,该文档可独立递增 MAJOR 版本,无需全部文档同步
  2. 小版本独立: 每个文档根据自己的变更频率独立递增 MINOR 版本
  3. 补丁版本独立: 每个文档独立递增 PATCH 版本
  4. 版本号位置: 文档头部 **文档版本**: X.Y.Z 格式
  5. 版本历史: 文档末尾必须维护版本历史记录

当前状态(2026-04-18

  • v5.x.x: 测试文档(10-测试-方案、测试-计划、测试-用例、测试-接口、测试-单元及子文档)、04-用户故事、测试-报告
  • v4.x.x: 其余文档(01-03、05-09、11-13、设计/运维/管理/评审)
  • 测试文档因体系拆分(子文档化)升为 v5;用户故事因重构升为 v5
  • 设计-Apple风格(原 v1.x)、13-Mermaid图集(原 v1.0.0)、管理-Agent-Team分工(原 v5.0.0)已于 2026-04-18 修正为 v4.x.x

Why: 用户发现文档版本号混乱(v1.0.0、v1.1.0、v4.0.0 混用),要求统一管理。后因测试文档体系拆分,部分文档 MAJOR 升至 v5 How to apply: 新建文档使用同类别文档的当前 MAJOR 版本;修改文档时按规则递增对应版本位;重大重构时可独立递增 MAJOR