mirror of
https://github.com/tradecatlabs/vibe-coding-cn.git
synced 2026-08-03 06:07:46 +00:00
tukuaiai
40 lines
1.5 KiB
Markdown
40 lines
1.5 KiB
Markdown
# Research 目录 Agent 指南
|
|
|
|
## 目录职责
|
|
|
|
`docs/research/` 存放新技术、新技术栈、优秀 repo、工程范式和工具趋势的短篇研究。
|
|
|
|
这里的文档回答：
|
|
|
|
- 它是什么。
|
|
- 它解决什么问题。
|
|
- 为什么值得关注。
|
|
- 适合什么场景。
|
|
- 有什么风险和替代方案。
|
|
|
|
## 文件地图
|
|
|
|
```text
|
|
research/
|
|
├── README.md # 索引入口：研究笔记导航
|
|
├── harness-engineering.md
|
|
├── tmux-ai-swarm.md
|
|
└── AGENTS.md # 本目录操作规则
|
|
```
|
|
|
|
## 修改规则
|
|
|
|
- 继承 `docs/AGENTS.md` 的 README 结构契约：H1 后直接进入 `## 字多不看`，再按 `快速导航 -> 完整细粒度目录 -> 使用方式 -> 正文` 排列。
|
|
- 每篇研究笔记聚焦一个技术、repo、范式或工具，并写入独立 `.md` 文档。
|
|
- 新增研究 `.md` 文件时，必须同步更新 `README.md`、`metadata/taxonomy.yml` 和必要的 `redirects.yml`。
|
|
- 研究内容稳定后，放入 `docs/concepts/`、`docs/references/` 或 `docs/philosophy/` 的对应章节。
|
|
- 外部项目、模型、工具、版本和事实状态可能变化，涉及最新信息时必须核验来源。
|
|
- 不在 README 正文中写 `和其他目录的边界` 或 `维护规则`；维护者规则只写本文件。
|
|
|
|
## 质量要求
|
|
|
|
- 不写新闻转述，要给出判断、边界、采用建议和后续观察点。
|
|
- 对不确定信息标注“待验证”或 TODO。
|
|
- 引入外部事实时优先引用官方文档、原始仓库、论文或可信一手来源。
|
|
- 修改后必须运行 `make sync-doc-toc` 和 `make test`。
|