Files
vibe-coding-cn/docs/AGENTS.md
T

55 lines
2.4 KiB
Markdown
Raw Normal View History

# Documents 目录 Agent 指南
## 目录用途
2026-05-02 23:30:50 +08:00
`docs/` 存放项目核心知识库文档,包含入门路径、核心概念与参考清单。
## 目录结构
2026-05-02 04:33:07 +08:00
```text
docs/
2026-05-02 04:33:07 +08:00
├── README.md # 知识库总索引
├── AGENTS.md # docs 总操作规则
2026-05-02 04:33:07 +08:00
├── getting-started/ # 从零开始、学习地图、环境与 AI CLI 配置
2026-05-03 20:25:27 +08:00
├── concepts/ # 线性总文档:核心概念、问题求解与工程思想
├── philosophy/ # 线性总文档:哲学方法论、思维模型与底层认知模型
├── research/ # 线性总文档:新技术、优秀 repo、工程范式和工具趋势研究
└── references/ # 线性总文档:工程实践、技术栈、清单与质量门禁
```
2026-05-01 22:01:14 +08:00
## 关键入口
2026-05-02 04:33:07 +08:00
- `README.md`:知识库总索引。
- `AGENTS.md``docs/` 总操作规则。
- `getting-started/README.md`:从零开始完整入门,包含学习地图、Vibe Coding 经验、网络配置、CLI 配置与开发环境搭建。
- `getting-started/AGENTS.md`:入门教程目录操作规则。
2026-05-03 20:25:27 +08:00
- `concepts/README.md`:线性总文档,包含问题求解、拼好码、系统构建方法、开发范式演进、语言层要素和递归自优化系统。
- `concepts/AGENTS.md`:核心概念目录操作规则。
- `philosophy/README.md`:线性总文档,包含思维模型、组合描述模型、编程之道和方法论工具箱。
- `philosophy/AGENTS.md`:哲学方法论目录操作规则。
2026-05-03 20:25:27 +08:00
- `references/README.md`:线性总文档,包含工程实践和技术栈。
- `references/AGENTS.md`:参考资料目录操作规则。
2026-05-03 20:25:27 +08:00
- `research/README.md`:线性总文档,包含新技术、优秀 repo、工程范式和工具趋势研究笔记。
- `research/AGENTS.md`:研究笔记目录操作规则。
2026-05-01 22:01:14 +08:00
## 操作规范
### 允许
2026-05-02 04:33:07 +08:00
- 新增/修改文档内容。
- 修复错误和过时信息。
- 为每个目录维护 `README.md` 作为索引入口。
- 为每个目录维护 `AGENTS.md` 作为 Agent 操作规则。
### 禁止
2026-05-02 04:33:07 +08:00
- 删除现有文档(除非明确要求)。
- 大规模重命名/移动文件导致链接失效(如必须调整,需同步更新引用)。
- 新增目录但不补 `README.md``AGENTS.md`
## 命名规范
2026-05-02 04:33:07 +08:00
- 文件名使用中文或清晰英文。
- 使用 Markdown 格式。
- 目录名使用简短英文,保证跨平台与链接稳定。