Agent 使用文档编写
把项目约定写成 AI 能直接读的 AGENTS.md 和 llms.txt,讲清哪些必须遵守、去哪找细节。
功能与用途
文档写得再详细,AI 读不完也记不住,真正要紧的规则往往被埋在中段,模型恰好最不关注那里。这个能力按三层来组织:把安全规则、架构约束和构建命令这类硬约束压进常驻上下文,控制在一两千到四千 token;细节拆成能单独检索的章节放参考库;外部检索只作为边角补充。它还会把整段代码换成文件路径和函数签名,把「不要这样做」写得明明白白,并给出 llms.txt 的标准写法。
适用场景
- AI 写代码时老是踩项目里明令禁止的写法,需要在常驻上下文里:AI 写代码时老是踩项目里明令禁止的写法,需要在常驻上下文里把红线说清楚
- 要发布对外 API,需要一份既方便人看、又能被 AI 抓取消:要发布对外 API,需要一份既方便人看、又能被 AI 抓取消费的文档站
- 接手了一个老项目,想让 AI 助手先读懂架构约束再动手改,而:接手了一个老项目,想让 AI 助手先读懂架构约束再动手改,而不是每次都问一遍
适用人群
- 维护 AI 编码助手配置的技术负责人
- 要写 SKILL.md 或 API 文档的开发者
- 做 RAG 知识库的知识工程师
使用步骤
- 把项目技术栈、必须遵守的规则、构建测试命令和文档结构告诉它。
- 它把硬约束和文档索引压进一份常驻上下文文件,控制篇幅。
- 它把详细内容按标题拆成能独立检索的章节,放进参考库。
- 它逐项自检:关键规则是否在文档开头、常驻部分是否超长、是否还有没配摘要的外链。
- 产出可直接放进项目的文档文件,交付前按清单核对一遍。
开始使用
将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。
技术信息
- 分类
- 编程
- 适用工具
- Codex、Claude Code、OpenClaw、Hermes、国内 Agent
- 使用难度
- 进阶
- 版本
- main
- 最近更新
- 2026-09-09
- 文件数
- 3
- 安装包大小
- 自动生成 ZIP
- 安全检查
- 基础检查通过
Use when writing documentation optimized for AI agent consumption - SKILL.md
使用前准备
- 无
依赖与权限
- 读取用户主动提供的内容