文档写得好不好？让这个 AI 帮你逐条审

拾遗·Skill精选官 内容创作者 2026-07-29 1159 阅读

写过文档的人都有这个经历——辛辛苦苦写完一篇 Guide，发出去之后被人挑出一堆小毛病：语气太正式了、链接文字写了”点击这里”、列表格式不统一……每次返工都心累。

Metabase 出品的 docs-review 这个 Skill，就是专门帮你做文档审查的 AI 助手。它不是随便给你打分，而是按照一套完整的风格规范，系统性地扫你的文档。

它怎么工作的？

两个模式，看你有没有 GitHub PR 权限：

  • PR 审查模式：如果你在 Review GitHub 的 PR，它会自动把每条意见发成 GitHub Review Comment，最后一次性提交，变成一个完整的审查意见。
  • 本地审查模式：没有 GitHub 权限？直接在你的对话里输出带编号的问题清单。

核心逻辑是一个检查清单，逐项扫过：

  • 语气问题：”utilize” → 改成 “use”，”users” → “people” 或 “companies”
  • 链接文字：”点击这里” → 改成描述性文字
  • 标题模糊：不能传达具体内容的不合格
  • 填充词：动不动说”这个很简单”的一律打回
  • 代码示例顺序：setup 命令要在 usage 之前
  • 截图问题：全屏截图太多，应该只截相关区域

输出格式什么样？

每条问题都带行号，举例：

**Issue 1: Formal tone**
Line 15: "Users cannot utilize this feature without proper configuration" 
可以更口语化。改成："You can't use this feature without setting it up first"

**Issue 2: Vague heading**
Line 8: "Process Overview" 这个标题太泛。
改成："How to set up data connections"

支持多少平台？

基本覆盖所有主流 AI Coding Agent：Claude Code、Codex CLI、Gemini CLI、OpenCode、OpenClaw、Cursor、Windsurf、Cline、Roo Code……装了就能用。

适合谁？

  • 技术文档团队：每次 PR 都要过一遍，现在 AI 帮你初筛
  • 开源项目维护者：不想自己一个个挑格式问题
  • SDK/工具库作者：API 文档质量直接影响采用率

说实话，大多数 AI 写文档的能力已经被接受了，但”审文档”这个环节的自动化还是空白。这个 Skill 把人类文档审查员的思维流程做了完整建模，扫一遍基本能覆盖 80% 的常见问题。

GitHub：https://github.com/metabase/metabase#.claude~skills~docs-review

GitHub: https://github.com/metabase/metabase/tree/master/.claude/skills/docs-review

评论区

0 条评论

登录后可评论。

拾遗·Skill精选官 1159 阅读