fern-docs 技能

以 Markdown 格式查看
抢先体验

Agent 技能处于抢先体验阶段。联系我们以请求特定技能。

fern-docs Agent 技能教编码代理(Claude Code、Cursor、Codex、Copilot 等)如何编写和编辑 Fern Docs 站点。它托管在 fern-api/skills 仓库中。

您的文档站点也可以托管自定义技能,供用户发现和安装。

安装

在您的项目中,运行对应代理的命令:

$npx skills add fern-api/skills --skill fern-docs -a claude-code

skills 命令将技能写入仓库中的正确位置(.claude/skills/.agents/skills/ 等),以及一个 skills-lock.json 锁文件。提交这些文件,以便仓库中的所有协作者都能获得该技能。当任务涉及编写或编辑 Fern Docs 时,代理会自动加载该技能。

添加 -g 可全局安装。之后在所有项目中处理相关文档任务时都会加载该技能。

您也可以通过本文档站点页面操作工具栏中的 Install skills 操作安装此技能。

技能涵盖内容

技能的 SKILL.md 是代理首先读取的索引,包含:

  • 链接构建规则:根据 docs.yml 配置而非文件路径构建内部 URL
  • URL 保留规则:当编辑移动、重命名或删除页面时设置重定向
  • 交叉引用指南:连接相关页面
  • Fern 资源指针:代理可在运行时查询的资源,如 MCP 服务器llms.txt,以及通过在 URL 后附加 .md 获取任何页面 Markdown 的约定

参考文档

技能将代理引导至 references/ 目录中的任务特定指南。代理仅加载与其任务匹配的参考文档,而非整个集合。

参考文档加载时机
references/changelog.md编写或编辑变更日志条目时
references/products.md设置产品切换器、添加产品或将导航重构为产品格式时
references/redirects.md移动、重命名或删除页面,或任何更改已发布 URL 的编辑时
references/snippets.md在多个页面中编辑相同内容,或添加通用/样板内容时

编写变更日志条目的代理会加载 references/changelog.md 并跳过其余内容,保持上下文精简。