mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-07-27 18:57:50 +00:00
f1f0b9fe75
Move the complete research domain from docs/research to root-level research, update indexes and path-aware tooling, and align raw snapshot governance and CODEOWNERS.\n\nVerified with make test and GitHub CI.
1.7 KiB
1.7 KiB
Concepts 目录 Agent 指南
目录职责
docs/concepts/ 存放项目的核心概念与工程认知框架。
这里的文档回答:
- Vibe Coding 的基本概念是什么。
- 新手如何定义问题、拆解问题和构建系统。
- 工程方法如何从经验沉淀为可复用模型。
文件地图
concepts/
├── README.md # 索引入口:核心概念导航
├── problem-solving.md
├── glue-coding.md
├── system-building.md
├── development-paradigms.md
├── language-layers.md
├── keyword-system.md
├── recursive-self-optimizing-system.md
└── AGENTS.md # 本目录操作规则
修改规则
- 继承
docs/AGENTS.md的 README 结构契约:H1 后直接进入## 字多不看,再按快速导航 -> 完整细粒度目录 -> 使用方式 -> 正文排列。 - 新增概念内容时,优先写入对应独立主题文档,并同步更新
README.md索引。 - 新增同级主题
.md文件前,必须确认它是稳定概念,并同步更新全仓链接、metadata/taxonomy.yml和必要的redirects.yml。 - 概念文档应优先使用稳定术语,避免同一概念多种叫法并存。
- 不把一次性操作步骤放入本目录;操作型内容应放入
docs/getting-started/或docs/references/。 - 不在 README 正文中写
和其他目录的边界或维护规则;维护者规则只写本文件。
质量要求
- 每个概念先说明它解决的问题。
- 尽量给出使用场景、判断标准和简单例子。
- 不确定的外部事实必须标注 TODO,或放入
research/等待验证。 - 修改后必须运行
make sync-doc-toc和make test。