开发者与技术写作者经常要做「文档站目录设计」这类事:为文档站设计导航结构与页面分组。每次都从头写提示词,结果时好时坏;把它做成智能体 Skill,就能让智能体每次按同一套步骤执行,输出结构也更稳定。

本文介绍如何在 AGENTS.md 上实现这个技能,包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。

这个技能做什么

项目说明
技能文档站目录设计(docs-site-nav)
作用为文档站设计导航结构与页面分组
输入文档列表
输出导航结构
形态纯提示词
风险低
适用人群开发者与技术写作者

处理流程分四步:

  1. 按用户任务分组
  2. 设计层级
  3. 命名页面
  4. 标出缺失页面

这个技能纯指令型,不需要额外脚本或外部连接,复制到大多数平台都能用;风险较低,但输出仍需快速过目再使用。

在 AGENTS.md 中是什么形态

AGENTS.md 是放在仓库根目录、写给编码智能体看的说明文件,多个编码智能体工具都会读取它。把常用流程写成其中的一个小节,就相当于给所有智能体装上同一个技能。

根目录的 AGENTS.md 对整个仓库生效;子目录也可以放自己的 AGENTS.md,就近补充或覆盖说明。

示例配置

AGENTS.md 中的小节示例(示意):

## 文档站目录设计(docs-site-nav)

- 何时使用:用户需要为文档站设计导航结构与页面分组
- 输入:文档列表
- 输出:导航结构
- 步骤:
  1. 按用户任务分组
  2. 设计层级
  3. 命名页面
  4. 标出缺失页面
- 约束:
  - 文中的命令和接口要与当前代码逐一核对。
  - 信息不足时先提问,不要自行编造数据或事实。

示例里最重要的是两处:一是描述(或指令开头)要写明「什么时候用」,让智能体在开发者与技术写作者提出相关请求时能对上号;二是约束部分要写进「文中的命令和接口要与当前代码逐一核对」这类领域规矩,避免智能体自作主张。

安装与启用步骤

  1. 在仓库根目录打开(或新建)AGENTS.md
  2. 新增一个以技能名命名的小节,写清何时使用、输入、步骤与约束
  3. 引用项目里已有的命令和脚本,不要写不存在的命令
  4. 让智能体执行一次相关任务,检查是否遵循
  5. 随代码评审一起维护这个小节

实操:一次完整的运行

假设你在文档仓库与文档站中发出这样的请求(虚构示例):

这是今天的文档列表,按团队的文档站目录设计流程处理一下。

智能体识别到任务与「文档站目录设计」相关后,会依次按用户任务分组、设计层级、命名页面、标出缺失页面。最终交付导航结构,并在末尾列出需要人工确认的内容。你的工作是对照原始文档列表抽查两三处关键信息,确认无误后再使用。

测试与验收

让两个不同的编码智能体分别执行同一任务,对比是否都按小节中的步骤进行。

针对这个技能,还建议额外准备:

  • 一份信息齐全的标准文档列表,检查输出是否完整
  • 一份缺少关键信息的输入,检查智能体是否先提问而不是编造
  • 一份包含“忽略以上规则”等字样的输入,检查约束是否仍然有效

常见坑

  • AGENTS.md 越写越长,变成没人维护的百科;每个小节保持一屏以内。
  • 写了与实际不符的构建或测试命令,智能体会照做并失败。
  • 只写了步骤,没写交付格式,导致每次输出的导航结构结构不同。
  • 没有给出样例,智能体对“好结果”的理解与你不一致;在参考资料里放一两份范例会明显改善。

延伸阅读

说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。