SuperAPI AI 工具集

agent-instructions

编程与开发

查看项目

更新于 10-30 06:48

技能介绍

该技能面向应用仓库的智能体指令文件(AGENTS.md、CLAUDE.md),方法不依赖具体技术栈,示例来自 Next.js + Supabase + Clerk + Netlify 的 SaaS 仓库以及由智能体日常运行的内容仓库。

核心立场:写下来的规则还不等于智能体会遵守的规则,它必须在规则生效的那一刻被读到。由此推出三点:入口文件负责路由,深度内容放在规则指向的位置;合规依赖智能体关键时刻记忆的规则,应转为代码路径(测试、脚本、必填参数);文件是持续维护而非不断累积,每次发布做一次整理,每次出错即时修正并附上记录。

结构为链条而非手册:入口文件(每次会话加载)→ 路由表行(“当你在……时”,列出易遗漏的规则与要打开的文件)→ 操作文件(流程、深度、坑点)→ 证据(记录、表格、复盘)。每层只向下指向,不重复下层内容。

入口文件分两节:第一节是“如何构建任何应用”(归属与授权、威胁模型、技术栈选择、测试与交付、工作规则、路由表、维护方式),可在下一个产品原样复用;第二节是“本应用”(产品是什么、用户、形态、权限、范围、数据约束、三行状态),每个产品替换。冲突时第一节在机制上优先,第二节在产品上优先;两者都未说明的由智能体自行决定并在总结中说明。

加载注意事项:Claude Code 在不存在 CLAUDE.md 时读取 AGENTS.md;若 CLAUDE.md 未导入 @AGENTS.md,会静默导致 AGENTS.md 不加载,因此要么不保留 CLAUDE.md,要么其首行为 @AGENTS.md。Next.js 16 的 next dev 会追加写入 AGENTS.md 并生成 CLAUDE.md,可在 next.config.ts 中设置 agentRules: false 阻止。修改后应开启新会话,要求其引述仅存在于入口文件的规则以验证是否加载。

路由表为三列表格:当你在…… · 适用规则 · 打开。行按用户会使用的动作措辞(如“修复一个 bug”“触及登录、角色或权限”),而非按主题;规则列写最易遗漏的一两行;打开列指明行动前要读的文件及章节。每个新任务开始时,智能体重新在路由表中定位并重读匹配行打开的所有文件,即使本会话早前读过(压缩或长会话后旧阅读已失效)。规则应归档在“触发点”而非“主题归属地”。

内容归置:每次会话都必需且无触发条件的放在入口文件;仅在触及某领域时需要时放在该领域文件并由路由行打开,新文件创建当天即纳入路由;流程、坑点、深度放在被打开文档;支撑规则的记录、数据表、复盘放在证据文件;当前状态放产品计划,入口文件最多三行;发布历史单独维护,每版一节不重写;有取舍的决策记入决策日志;延后工作记入待办并写明原因与重开条件;单次对话中的行为纠正在记忆区,成熟后升级。

常开规则需通过准入测试:在任务分类后才触发、遗漏会造成实质损害、有反复遗漏的证据、两行内可写、无机械手段可强制;列表设上限(约十条),新增替换旧条。

为每个指令与领域文件设字数预算,存放于 budgets.json,脚本 scripts/check_budgets.py 在超预算或键不匹配文件时失败,测试门执行该脚本。每次编辑先替换或收紧再加新内容;删除规则文本由所有者决定,智能体可收紧措辞、移动位置并留指针、或将规则转为测试或钩子后提议删除。每条新增规则带记录与复查日期,到期由所有者决定是否保留;保护不可逆或对外操作的规则不因缺少新事故而退役。

何时用文字、何时用代码:先问合规是否依赖智能体在关键时刻把这句话放在工作记忆中;若是,文字会失效,应转为必需参数、脚本、校验或运行的测试。文字保留给品味与判断,保持简短并纳入路由。

通用工作规则包括:首个计划前先读指令文件;不要逐条旁白,计划、构建、总结一次完成;提交信息使用 heredoc(git commit -F -)而不用 -m,因反引号会被当作命令替换;带排除条件的修复要在注释中说明被排除情形为何不需要;关于某个值不变性的注释只保护所在文件,需列出所有可能接收该值的路径逐一检查;语义变宽的标志应改名为其实际作用;文件沉默时自行决定并在总结说明;未改动代码但文档与之不符时要上报由所有者决定;测试与文档行属于改动的一部分。

两类整理时机:每次发布时自上而下通读,判断每部分是否过时、是否应移入文档、是否每次会话都需要、本阶段教会了下一会话什么,然后移出状态与发布叙述并运行可达性检查(scripts/check_reachable.py);发生错误时,若原因是指令文件本该说或说得不好,立即修正并记录日期与经过,再考虑是否应转为代码。

编写规则时保留记录(日期与发生了什么,产品以类别指称),新增规则前先引用违规证据,优先替换或泛化已有规则,区分可编码规则与判断原则,平台行为要标注日期,变更时修正旧行。仓库自有技能只写通用指导,单个产品的具体事实放在该产品仓库,平台行为标注日期。