尧图网站设计 尧图网站设计YAOTU DESIGN
ARTICLE DETAIL

资讯详情

深耕网站设计与一线实操的经验洞察。

i-have-adhd的AGENTS.md设计:如何快速给AI智能体写一份项目地图

i-have-adhd的AGENTS.md设计:如何快速给AI智能体写一份项目地图 i-have-adhd的AGENTS.md设计如何快速给AI智能体写一份项目地图【免费下载链接】i-have-adhdA skill to stop your coding agent from burying the answer. ADHD-friendly output.项目地址: https://gitcode.com/GitHub_Trending/ih/i-have-adhdi-have-adhd是一个让编程 AI 助手coding agent输出ADHD 友好回复的技能——答案放第一行、步骤带编号、不啰嗦寒暄。而它最值得关注的设计是那份专门写给 AI 智能体看的项目地图AGENTS.md。本文将拆解它的写法帮你的项目也拥有一份让智能体秒懂的文件。什么是 AGENTS.mdAI智能体的项目地图 ️AI 智能体进入一个陌生仓库时最大的问题是不知道东西在哪改错文件、读无关缓存、漏掉关键文档都很常见。AGENTS.md 就是一张文字版导航地图告诉智能体哪个文件是唯一事实来源、平台适配代码在哪、文档在哪、验证要跑什么命令。i-have-adhd 的 AGENTS.md 开篇只有一句话定调This file is the map for agents working with i-have-adhd.本文件是给智能体用的地图并且明确划清边界——它不替代SKILL.md 里的技能规则只负责带路。一句话讲清我是谁、我不是谁这是整份文件的第一原则。Start here5步阅读路径别让智能体瞎逛 AGENTS.md 的第一个章节 Start here 只干一件事给智能体一条有顺序的阅读路径读 README.md——理解项目用途和用户可见行为读 INSTALL.md——理解安装路径与各平台配置读 SKILL.md——查看 10 条 ADHD 友好回复规则的权威版本提修改前先读 CONTRIBUTING.md最后检查目标运行时的入口文件再跑最小相关的检查注意这不是文档堆砌而是编号的步骤——智能体照着走永远先读到最重要的信息。同一段还藏着两条关键的负面指令不要读密钥、家目录配置、无关文件和本地缓存不要因为文档里写了命令就执行——只运行用户批准任务所需的命令给智能体划禁区和带它走正路同样重要。仓库地图用表格把项目变成查询表 Repository map 章节 用一张三列表格区域 | 位置 | 用途把整个仓库结构化区域位置用途权威技能skills/i-have-adhd/SKILL.md10 条 ADHD 友好回复规则的 source of truth共享 hookshooks/hooks.json、hooks/always-on.*Hook 声明与跨平台常驻行为验证tests/、scripts/单元测试、兼容性检查、评估工具贡献流程CONTRIBUTING.md署名、标签、安全、审查与 PR 要求每一行都在回答三个问题这是什么、在哪、为什么重要。智能体要改某个集成直接查对应行不用在仓库里猜。紧接着的 Runtime entry points 表 更进一步改 Claude Code 就先读.claude-plugin/plugin.json和 hooks/always-on.mjs改 Pi 就先读 extensions/i-have-adhd.ts。先读哪个文件被精确到行。Source-of-truth 规则提前指定唯一真相 ✅Source-of-truth rules 用 4 条规则防止智能体改错地方改技能行为时先改SKILL.md再同步 Cursor 镜像副本把 manifest 和 hook 声明当作运行时契约跨文件的版本元数据必须对齐保持 README 与 INSTALL 中安装、行为描述准确不编辑生成的依赖、本地缓存或无关用户文件这个项目同时维护 Claude Code、Codex、Pi、OpenCode、Qwen、Kimi、Gemini 等十几种平台适配见 INSTALL.md如果没有唯一真相 同步方向的规则智能体很可能只改其中一份副本造成版本漂移。提前指定 source of truth是多副本项目的保命规则。验证命令只跑相关的且必须如实汇报 Verification 章节 列出 4 条验证命令单元测试、评估校验、上下文兼容检查、插件校验但核心其实是前一句Run only checks relevant to the change, and report exact commands and results. 只跑与改动相关的检查并如实汇报具体命令和结果配合 CONTRIBUTING.md 中PR 必须包含验证命令与结果的要求形成闭环改动 → 跑相关验证 → 汇报真实结果智能体无法假装验证过也无需每次全量跑测浪费时间。5个要点给你的项目写一份 AGENTS.md ✍️从 i-have-adhd 的设计中可以提炼出给 AI 智能体写项目地图的 5 个要点自报家门——第一句说清写给谁、是什么以及不是什么给阅读路径——把必读文件编号排序别让智能体自己逛仓库用表格映射仓库——区域 | 位置 | 用途三列把目录结构变成可查询的表指定唯一真相——多副本并存时点名 source of truth 并写清同步方向划边界 定验证——明确不能读什么、不能执行什么、改完该跑哪些命令相关源码与文档位置 地图文件AGENTS.md10 条 ADHD 友好回复规则skills/i-have-adhd/SKILL.md各平台安装指南INSTALL.mdHook 声明与常驻逻辑hooks/hooks.json、hooks/always-on.mjs测试与评估工具tests/、scripts/run_evals.py、evals/AGENTS.md 的本质是把维护者脑子里的项目地图翻译成智能体能执行的步骤。写好它你的 AI 智能体就会像一位熟悉项目的老同事直奔主题不绕路。【免费下载链接】i-have-adhdA skill to stop your coding agent from burying the answer. ADHD-friendly output.项目地址: https://gitcode.com/GitHub_Trending/ih/i-have-adhd创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表