Audit a doc, guide, README, or block of prose against the good-docs-writing style guide and report violations. Use when the user asks to review, critique, lint,
复制下面这句话,粘贴给 Claude Code、Codex、Cursor 等 AI 编程工具,它会读取安装说明并在你确认后完成安装。
请阅读 https://ai.atlankj.com/install/asset/gh-good-docs-audit-1dbb533cb7d3 ,按照其中的说明把「good-docs-audit」安装到你(当前 AI 工具)中。执行前先告诉我将运行的命令和写入的位置,等我确认。
查看 AI 将读取的安装说明正在读取 GitHub 原文…
内容来自 GitHub 原始文件,由原作者维护。在 GitHub 查看
Review target documentation against the good-docs-writing rules and report where the writing drifts from that voice. Default behavior is report only: produce findings, do not edit. Only modify files if the user explicitly says to fix, rewrite, or apply.
Read references/audit-process.md for the procedure, the prioritized violation checklist, the report format, and the reporting rules.
Non-negotiables:
good-docs-writing (and its references/style-guide.md) first. Those rules are the rubric; this skill is the process.file:line for every finding and quote the exact offending text.