Next.js 文档更新助手
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_e40a4360/documentation-updater。
技能介绍
问题背景
Next.js 仓库里代码改动经常牵连 API 参考、配置说明和指南,维护者评审 PR 时需要人工判断哪些文档要改、哪些页面是 Pages Router 共享内容、新增功能应落到哪类文档。这个技能把“从代码差异到文档更新”的流程固定下来,减少遗漏。
工作方式
- 先执行
git diff canary...HEAD --stat查看改动文件,再根据references/CODE-TO-DOCS-MAPPING.md映射到docs/01-app/03-api-reference/等路径。 - 对已有文档,技能会读取当前结构、frontmatter、router-specific 内容,识别新增 props、行为变化、废弃特性和新示例,并逐项征求确认后再修改。
- 对新功能,技能会判断应创建组件、函数、配置、指南或文件约定文档,按 kebab-case 和编号前缀命名,套用 API Reference 或 Guide 模板。
- 修改后检查 frontmatter、代码块文件名、TypeScript/JavaScript switcher、props 表格和相关链接,并运行
pnpm lint。
适用边界
这个技能面向 Next.js 文档维护场景,尤其适合 App Router 文档和 Pages Router 共享内容判断。它依赖仓库中的 mapping 与 conventions 文件,若 references/DOC-CONVENTIONS.md 或 mapping 不完整,结果会依赖现有文档结构;编辑前会逐项确认,但不会替代人工对 API 语义和迁移指南的准确判断。
使用场景
- 评审 Next.js 组件 PR 时,根据 image.tsx 的 props 改动补齐组件 API 参考。
- 处理配置项 PR 时,按代码映射更新 docs/01-app/03-api-reference/05-config 页面。
- 新增函数特性时,创建 API 参考文档,补充 frontmatter、代码示例和相关链接。
- 提交前检查文档格式,确认 props 表格、TS/JS switcher 和 pnpm lint 通过。
适合人员
- 负责 Next.js 文档 PR 审查的维护者,需要快速判断哪些 API 页面要更新。
- 维护 App Router 组件文档的工程师,需要在 props 变化后补齐参考表和示例。
- 参与 Next.js 新特性落地的作者,需要按模板创建并格式化新文档。
- 处理 Pages Router 共享内容的贡献者,需要找到应编辑的源文件而不是镜像页。