diff --git a/AGENTS.md b/AGENTS.md index 15e4040d3..6ee92a9db 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -277,7 +277,7 @@ **铁律10: 验证后信** - 每次修改后必须验证编译通过,不信记忆 -**铁律13: 文档统一管理** +**铁律13: 文档统一管理(P0绝对铁律)** - 所有文档存储在 `MD/` 目录 - 文件名:大写英文+下划线(如 `BACKEND_CHECKLIST.md`) - 文档头部必须包含元数据块(文档类型、版本、日期) @@ -684,7 +684,7 @@ git status && git add -A && git commit -m "feat(module): desc" && git push origi **铁律10: 验证后信** - 每次修改后必须验证编译通过,不信记忆 -**铁律13: 文档统一管理** +**铁律13: 文档统一管理(P0绝对铁律)** - 所有文档存储在 `MD/` 目录 - 文件名:大写英文+下划线(如 `BACKEND_CHECKLIST.md`) - 文档头部必须包含元数据块(文档类型、版本、日期) @@ -1077,3 +1077,5 @@ git status && git add -A && git commit -m "feat(module): desc" && git push origi --- > 📅 最后同步: 2026-06-06 15:09 | 源文件: RULES.md | 重新同步: `bash scripts/sync-ai-rules.sh` + + diff --git a/MD/specs/IRON_RULES.md b/MD/specs/IRON_RULES.md index 1bbc6d4bc..0638a80fa 100644 --- a/MD/specs/IRON_RULES.md +++ b/MD/specs/IRON_RULES.md @@ -16,7 +16,7 @@ | #2 | Flyway 数据库迁移 | P0 | 数据库变更 | | #3 | 先分解再行动 | P1 | 非平凡任务 | | #4 | 验证后信 | P1 | 编译/构建 | -| #5 | 文档统一管理 | P1 | 文档产出 | +| #5 | 文档统一管理(P0绝对铁律) | P0 | 文档产出 | | #6 | 测试通过后才提交 | P0 | 代码提交 | | #7 | 前后端API路径对齐 | P0 | 接口开发 | | #8 | 铁律和规范文档放MD目录 | P1 | 规范文档 | @@ -120,26 +120,38 @@ cd healthlink-his-ui && npm run build:dev --- -### 铁律 #5: 文档统一管理 +### 铁律 #5: 文档统一管理(P0 绝对铁律) -**所有文档必须存储在 `MD/` 目录中,遵循文档规范。** +**所有文档必须存储在 `MD/` 目录中,禁止在项目其他位置创建文档文件。** -#### 目录结构 +#### 绝对禁止 +| ❌ 禁止行为 | 说明 | +|------------|------| +| 在项目根目录创建 `.md` 文件 | 如 `README.md`、`TODO.md`、`NOTES.md` 等 | +| 在子模块目录创建文档 | 如 `healthlink-his-server/DESIGN.md` | +| 在 `docs/` 目录存放文档 | 必须移动到 `MD/` | +| 随意创建新目录 | 必须使用已有目录结构 | +| 使用中文作文件名 | 必须使用大写英文+下划线 | + +#### 目录结构(必须遵守) ``` MD/ ├── DOCUMENTATION_STANDARD.md # 文档管理规范 -├── architecture/ # 架构设计 +├── architecture/ # 架构设计文档 +├── design/ # 模块设计文档 ├── development/ # 开发计划与记录 ├── standards/ # 国家/行业标准 ├── specs/ # 技术规范与流程 ├── bugs/ # Bug分析与修复记录 ├── guides/ # 使用指南 -└── upgrade/ # 升级记录 +├── upgrade/ # 升级记录 +├── test/ # 测试文档 +└── 需求/ # 需求文档(允许中文目录名) ``` #### 命名规范 - 文件名使用 **大写英文+下划线**(如 `GRADE3A_DETAILED_DESIGN.md`) -- 不使用中文作文件名 +- 不使用中文作文件名(需求目录除外) - 不使用空格分隔单词 - 版本号标注在文件名末尾(如 `_V2`) @@ -234,6 +246,7 @@ MD/ |------|------|---------| | P0 违规 | 跳过测试直接提交 | 必须回滚并重新测试 | | P0 违规 | 数据库变更不走Flyway | 回滚数据库变更,重新用Flyway执行 | +| P0 违规 | 在MD目录外创建文档 | 立即移动到MD目录,删除原文件 | | P1 违规 | 未分解就行动 | 补充分析和计划文档 | | P1 违规 | 文档不规范 | 补充元数据和格式 |