AI 指令:如何编写 ai.md 工作交接文档
本页面向 AI 提供「如何编写 ai.md 工作交接文档」的固定指令。AI 通过 URL 访问本页后,按下列规则为项目生成/更新 ai.md。
第一步:明确使命
ai.md 是一份「AI 工作交接文档」,放在项目根目录。目的是让任何新接手的 AI(或人类)只读这一个文件,就能无缝继续工作。
它的受众是 AI 助手。请用中文、Markdown 编写,结构固定为下面三段式,正文要具体、可执行,不要空话。
第二步:三段式结构(必须遵守)
第一部分:还没做完的事 & 动手前要注意什么
回答「接下来还要做什么?开始之前要注意哪些坑?」
- 用
- [ ]待办清单列出所有未完成事项,能标责任步骤就标(如「部署到 Cloudflare Pages」)。 - 「动手前注意事项」逐条编号,写清会被忽略但容易踩坑的规则,例如:不擅自 push、不提交密钥、别破坏指定文件结构、分支名、环境差异等。
第二部分:历史记录(我们做了什么、怎么做的)
回答「已经完成的事情,按时间线详细还原过程。」
- 按时间倒序或正序分条记录,标注日期。
- 每条写清:创建/修改了哪些文件、做了什么改动、执行过哪些关键命令(
git init、git push等)。 - 最后附一份当前仓库文件结构树,让接手者一眼看清现状。
第三部分:为什么做这件事
回答「背景与动机,为什么值得做?」
- 写清目标、解决的痛点、带来的价值。
- 说明复用方式:其他人或 AI 如何受益于这份工作。
第三步:写作规则
- 全文使用标准 Markdown:标题用
##,清单用- [ ]/-,命令与文件路径用行内代码`。 - 第一部分和第二部分必须给出「具体事实」(真实文件名、真实命令、真实 commit),不要杜撰。
- 不确定的信息标记为
TODO或留空待补充。 - 语言简洁,一个
ai.md控制在可一次读完的篇幅。
第四步:模板(直接填充即可)
# <项目名> 交接
> 本文件是给 AI 的工作交接文档,请先阅读此文档再继续对本仓库进行操作。
## 一、还没做完的事 & 动手前注意
### 尚未完成 / 待办
- [ ] 待办事项 1
- [ ] 待办事项 2
### 动手前注意事项
1. 注意事项 1
2. 注意事项 2
## 二、历史记录(我们做了什么、怎么做的)
- 日期:完成的事情,涉及的文件与命令。
- 日期:完成的事情,涉及的文件与命令。
当前仓库状态:
```text
项目/
├── 文件
└── 文件
```
## 三、为什么做这件事
- 目标:
- 价值:
- 复用方式:
第五步:交付标准
- 生成的文件保存为项目根目录的
ai.md。 - 再次通读一遍,确认三段式齐全、待办可勾选、历史有据可查、动机清楚。
- 如需落盘,询问用户是否提交推送,不要擅自
git push。