docs: codify docs structure contract

This commit is contained in:
tukuaiai
2026-05-05 02:11:38 +08:00
parent e6012e88c6
commit 370f0432ac
8 changed files with 53 additions and 3 deletions
+3 -1
View File
@@ -21,14 +21,16 @@ references/
## 修改规则
- 继承 `docs/AGENTS.md` 的 README 结构契约:H1 后直接进入 `## 字多不看`,再按 `快速导航 -> 完整细粒度目录 -> 使用方式 -> 正文` 排列。
- 新增参考资料时,直接追加到 `README.md` 的对应章节。
- 检查清单、模板、质量门禁和经验类内容优先合并进 `工程实践` 章节。
- 技术选型、技术栈组合和学习路径优先合并进 `技术栈` 章节。
- 不在本目录写一次性研究笔记;新技术判断应先放入 `docs/research/`
- 不在 README 正文中写 `和其他目录的边界``维护规则`;维护者规则只写本文件。
## 质量要求
- 参考文档必须可执行、可检查、可复用。
- 门禁类内容尽量转成测试、CI、脚本、schema、类型或检查清单。
- 不确定项必须标注 TODO,不能编造成熟结论。
- 提交前必须运行 `make test`,确保锚点、链接和目录结构一致。
- 提交前必须运行 `make sync-doc-toc``make test`,确保锚点、链接和目录结构一致。