前言¶
改完功能再补文档,往往靠记忆和自觉:哪些页面受影响、API 参考要不要改、PR 里有没有漏掉 docs/ 下的 MDX,审查时很难系统化核对。手工对照 diff 扫目录,既慢又容易漏。
下面介绍 SkillHub 上的「技术文档更新」(@user_e40a4360/documentation-updater)。它是一套面向 Next.js 项目文档的引导式工作流,根据源代码变更去分析、更新或新建文档,并把 PR 阶段的文档完整性检查拆成可重复执行的步骤,而不是每次从零想 checklist。
这是什么¶
「技术文档更新」是社区来源(community)的 Agent Skill,坐标 @user_e40a4360/documentation-updater,当前版本 1.0.0,分类为 knowledge-management,由发布者 user_e40a4360(SkillHub 页面展示作者为踏山河)维护。Skill 采用通用的 SKILL.md 格式,不需要 API Key(requires_api_key=false)。
定位可以概括为:在 Next.js 文档仓库里,用标准化引导把「代码改了什么」映射到「文档该动哪里」,减少代码与 docs/、MDX、API 参考之间的漂移。
核心功能¶
依据官方简介,已核实的能力包括:
- 变更驱动的文档分析:根据源代码变更,判断需要更新或新建的文档范围。
- 引导式工作流:通过一系列标准化步骤规范文档修改过程,而不是一次性自由发挥。
- PR 文档完整性:面向 Pull Request 审查场景,用于检查本次改动是否配套了应有的文档更新。
- Next.js 文档语境:工作流针对 Next.js 项目文档结构,简介中明确关联
docs/、docs/01-app、docs/02-pages、.mdx、MDX、API reference等路径与形式。
Agent 在以下意图下应启用该 Skill(原文触发表述,便于你对照使用):
- 用户要求 update documentation for my changes、check docs for this PR、what docs need updating、sync docs with code、scaffold docs for this feature、document this feature、review docs completeness、add docs for this change、what documentation is affected、docs impact;
- 或对话中出现
docs/、docs/01-app、docs/02-pages、MDX、documentation update、API reference、.mdx files等关键词。
安装与启用¶
SkillHub 页面给出的安装方式是:让 AI 参照官方安装说明,安装坐标 @user_e40a4360/documentation-updater。安装文档地址为 SkillHub 安装与优先源配置。
先做环境检查,再安装 Skill 到当前 Agent 能识别的 skills 目录(安装时必须指定 --dir,否则默认落在 ./skills/ 且可能不被识别)。
command -v skillhub && skillhub --version
若未安装 CLI,可使用安装文档中的完整安装命令:
curl -fsSL https://skillhub-1388575217.cos.ap-guangzhou.myqcloud.com/install/install.sh | bash
安装本 Skill 时,将 <skills 目录> 换成你当前客户端使用的路径。安装文档中列出的常见路径包括:
- Cursor:
~/.cursor/skills/ - Claude Code:
~/.claude/skills/ - Codex:
~/.codex/skills/或项目下的.agents/skills/
示例(目录需按你的环境替换):
skillhub install @user_e40a4360/documentation-updater --dir ~/.cursor/skills/
也可在对话中直接发送 SkillHub 页面提供的提示词,让 AI 按 skillhub.md 完成安装,效果等价于上述流程。
典型用法¶
公开资料未附带固定 CLI 子命令;使用方式是在已安装 Skill 的 Agent 里,用自然语言描述本次代码变更或 PR 目标,并点明文档同步需求。下列表述与官方简介中的触发场景一致,可直接复用或改写:
我这次 PR 改了 App Router 下的配置行为,请 check docs for this PR,列出 docs/01-app 里哪些 .mdx 需要更新。
sync docs with code:根据当前分支相对 main 的改动,说明 what documentation is affected,并 scaffold docs for this feature 的草稿结构。
review docs completeness:这次变更是否缺少 API reference 或 docs/02-pages 下的对应页面?
经过上面的步骤,Agent 会按 SKILL.md 中的引导式工作流推进:从变更范围推导文档影响面,再组织更新或新建文档,而不是只给泛泛的写作建议。
适用场景与注意¶
适合谁
- 维护 Next.js 官方风格或类似结构的文档站(
docs/分区、MDX、API 参考并存)的开发者与文档贡献者。 - 在 PR 审查中需要可重复的「文档是否跟代码一起变」检查清单的团队。
限制与注意
- 工作流面向 Next.js 项目文档;非 Next.js 或文档目录命名完全不同的仓库,触发词里的路径(如
docs/01-app)可能不完全匹配,需自行说明实际目录结构。 - 评分 100000、下载 1401、安装 2 等数据来自 SkillHub 页面统计,仅作选用参考,不代表与你本地仓库的兼容结论。
- 文档内容质量仍取决于变更说明是否清晰、仓库内现有 MDX 约定是否一致;Skill 规范的是过程与检查维度,不能替代人工对技术准确性的终审。
结尾¶
若你经常在 PR 里追问「文档改了吗、改全了吗」,「技术文档更新」把 Next.js 文档同步收成一条可重复的引导式路径,并与 docs/、MDX、API 参考等常见触点对齐。安装与详情见 SkillHub:
- 页面:https://www.skillhub.cn/skills/user_e40a4360/documentation-updater
- API 入口:https://api.skillhub.cn/user_e40a4360/documentation-updater