SuperAPI AI 工具集

better-agent-md

编程与开发

查看项目

更新于 10-15 20:12

技能介绍

用途:审计、改进或重写仓库级智能体指令文件,例如 AGENTS.md、AGENT.md、CLAUDE.md、GEMINI.md 或仓库专属的智能体上下文文件。核心思路是把这类文件视为操作指南,而不是通用文档。

工作流程:先找到目标文件并完整阅读;只读取验证其声明与命令所需的代码库文件;在给出建议前先阅读 references/how-to-write-a-better-agent-md.md,并将其作为唯一参考(除非用户提供新的源材料)。随后把每条指令归类为保留(仓库专属、流程性、长期有效且智能体难以低成本推断)、重写(想法有用但含糊、臃肿、冗余或过于宽泛)或删除(冗余概述、快速变化的细节、面向人的文档或不必要的要求)。要求同时给出批评与整改,不能只停留在观察层面。

优化目标:尽量减少强制要求,因为额外步骤会增加成本,且智能体倾向字面执行;只保留高价值的流程性指导,如命令、工作流、验证步骤、仓库风险与项目专属约定;偏好聚焦的指令集而非全面的仓库摘要;保持指导长期稳定,把易变细节移出;优先针对反复出现的失败模式或常见错误;建议要关联执行影响,而非仅凭风格偏好。

评审标准:逐条检查指令是否可执行(如“对 src/foo/ 下的文件运行 pnpm test:unit”优于“小心并遵循最佳实践”)、是否流程性而非描述性、是否仓库专属、是否长期有效、是否必要、智能体能否低成本验证。常见弱点包括自动生成的仓库概述、无执行路径的风格规则清单、对所有任务强制要求的步骤、混淆人类入门材料与智能体执行指导、相互冲突的目标、已失效的命令、扩大探索却不提高成功率的强制要求。

修复方式:用简短的操作性小节替代散文式摘要;把含糊建议转为明确的触发条件与动作;把解释性材料移到 README.md 等文档;只保留能实质改变智能体行为的最小仓库专属规则;尽量归为 2-3 个短模块(关键工作流、验证与测试、仓库专属风险或约定)。

预期输出:审查现有文件时返回发现(弱点、影响及保留/重写/删除判断)、改进稿(修订文件或补丁,而非仅评论)、理由(关联参考文档中的具体原则)、待解问题(仅列出阻碍可靠重写的缺失仓库事实)。若用户要求修复,默认直接编辑文件或提供可直接套用的替换稿。替换稿写作规则:使用短小节与直接祈使语气,多用要点、每条单一目的,避免重复智能体可从配置或代码中发现的信息,不承诺未经验证的工作流;若原文件基本是噪音,则从零重写而非逐行修改。