mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-07-28 11:17:46 +00:00
1.4 KiB
1.4 KiB
References 目录 Agent 指南
目录职责
docs/references/ 存放工程实践、技术栈、质量门禁、模板和检查清单。
这里的文档回答:
- 项目应该如何组织。
- AI 编程应该如何设置硬门禁。
- 常见技术栈如何选择和组合。
- 工程经验如何变成可执行清单。
文件地图
references/
├── README.md # 线性总文档:工程实践、技术栈
├── AGENTS.md # 本目录操作规则
修改规则
- 继承
docs/AGENTS.md的 README 结构契约:H1 后直接进入## 字多不看,再按快速导航 -> 完整细粒度目录 -> 使用方式 -> 正文排列。 - 新增参考资料时,直接追加到
README.md的对应章节。 - 检查清单、模板、质量门禁和经验类内容优先合并进
工程实践章节。 - 技术选型、技术栈组合和学习路径优先合并进
技术栈章节。 - 不在本目录写一次性研究笔记;新技术判断应先放入
docs/research/。 - 不在 README 正文中写
和其他目录的边界或维护规则;维护者规则只写本文件。
质量要求
- 参考文档必须可执行、可检查、可复用。
- 门禁类内容尽量转成测试、CI、脚本、schema、类型或检查清单。
- 不确定项必须标注 TODO,不能编造成熟结论。
- 提交前必须运行
make sync-doc-toc和make test,确保锚点、链接和目录结构一致。