AI 协作维护
01MVP 当前仓库如何用 AI 维护代码、文档、规则和提交
这个仓库本身就是样板
01MVP 不只是给产品接入 AI 功能,也把 AI 当成日常维护仓库的协作者。这个仓库里的 AI 协作不是靠每次重新解释上下文,而是把稳定规则、任务细则和专项工作流沉淀进仓库。
这样做的目标很直接:
- AI 接手任务前能知道项目边界,不需要从零猜目录结构。
- 文档、UI、数据库、API、包结构各有自己的规则来源。
- 代码和文档修改可以带着验证和提交一起完成。
- 新规则能进入仓库,而不是只停留在某一次对话里。
维护结构
| 层级 | 位置 | 作用 |
|---|---|---|
| 入口说明 | AGENTS.md | 保存所有任务都要遵守的硬边界,并告诉 AI 不同任务该读哪份 reference |
| 工具兼容 | CLAUDE.md | 指向 AGENTS.md,让 Claude Code 也使用同一套规则 |
| 按需细则 | .agents/references | 文档、UI、包架构、数据库、API、测试提交和命令表等任务规则 |
| 专项能力 | .agents/skills | Next.js、Better Auth、Zeabur、Wrangler、模板初始化等可复用工作流 |
| 人类文档 | apps/01mvp-web/content/docs | 给模板使用者看的背景、路径和判断方式 |
根说明文件故意保持短。AI 只在任务需要时读取相关 reference,这样上下文更干净,也更不容易把 UI 规则、数据库规则和文档规则混在一起。
一次任务怎么推进
先读入口规则:AI 先看 AGENTS.md,确认当前任务属于文档、UI、API、数据库还是包结构。
按需加载细则:例如改文档时读取 .agents/references/docs-authoring.md;改 UI 时读取 .agents/references/ui-theme.md;改 Hono API 时读取 .agents/references/api-hono.md。
检查当前仓库状态:动手前看 git status,区分用户已有改动和本次任务需要修改的文件。
改真实文件:按仓库现有结构修改代码或 MDX,不把内部说明写进对外页面,也不做无关清理。
做针对性验证:文档任务优先跑 docs 检查;UI 任务看主题和移动端;数据库、API、包改动跑对应类型检查或测试。
只提交本次范围:任务完成后,只 stage 和 commit 当前对话相关文件,避免把用户正在做的其它改动混进同一个提交。
为什么要拆 reference
以前项目说明容易变成一份很长的总手册。AI 每次都读完整内容,会有三个问题:
- 小任务也要加载大量无关规则。
- UI、文档、数据库、部署规则混在一起,容易误用。
- 两份入口文件同时维护时,很容易出现内容漂移。
现在的做法是:AGENTS.md 只做入口和硬边界,细节放到 .agents/references。比如:
| 任务 | AI 读取 |
|---|---|
| 修改 MDX 文档 | AGENTS.md + .agents/references/docs-authoring.md |
| 修改可见 UI | AGENTS.md + .agents/references/ui-theme.md |
| 修改数据库 | AGENTS.md + .agents/references/database-drizzle.md |
| 修改 Hono API | AGENTS.md + .agents/references/api-hono.md |
| 调整包结构 | AGENTS.md + .agents/references/package-architecture.md |
Skills 负责更具体的工作流
Reference 解决的是项目规则,Skill 解决的是专项任务。
例如:
- 初始化一个真实产品站时,用
01mvp-template-initializer。 - 改数据库 schema 或 migration 时,先读
.agents/references/database-drizzle.md。 - 改 Next.js App Router、RSC、metadata 或图片时,用
next-best-practices。 - 做 Zeabur 部署时,用
zeabur-deploy、zeabur-variables和zeabur-domain-url。 - 写 Cloudflare Workers 或 Wrangler 配置时,用
workers-best-practices和wrangler。
这样 AI 不需要把所有领域知识都塞进根说明。常见任务有稳定入口,复杂任务再读取更专业的 Skill。
文档和代码一起维护
这个仓库的原则是:规则影响谁,就写给谁看。
- 只影响 AI 执行方式的规则,放进
AGENTS.md或.agents/references。 - 会影响模板使用者判断和操作的内容,写进
content/docs。 - 只属于当前实现细节的内容,优先留在代码和类型里,不额外写一份容易过期的文档。
所以 AI 在维护文档时,不是把代码翻译成文章,而是补充人类需要知道的背景、路径、约束和下一步。
可以复制到自己的项目
如果你用 01MVP 模板做自己的产品,可以从这个结构开始:
AGENTS.md
CLAUDE.md
.agents/
references/
docs-authoring.md
ui-theme.md
package-architecture.md
database-drizzle.md
api-hono.md
workflow-testing-git.md
commands.md
skills/
your-project-initializer/
SKILL.md最重要的不是文件名,而是分工清楚:
- 入口文件管硬规则和读取路径。
- Reference 管按需规则。
- Skill 管可复用工作流。
- Docs 管用户真正需要理解的内容。
当这个结构跑通后,AI 就不只是一次性写代码的工具,而是能持续维护项目上下文的协作者。