good-docs-audit
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, or check the voice and tone of documentation or text. Produces a structured findings report (file:line, rule violated, offending text, suggested rewrite) and does NOT edit files unless explicitly asked.
ソース情報
- リポジトリ
- ComposioHQ/composio
- ソースの最終更新活動
- 2026年7月30日 12:31
- 検出された SKILL.md の言語
- 英語
- スター
- 30,500
- フォーク
- 4,849
インストール方法
デフォルトでは、最初にソースを確認する Prompt が選択されています。直接コマンドに切り替えるか、ローカルコピーをダウンロードすることもできます。
ソースファイルを確認
インストールを決める前に、SKILL.md と SkillsMP に表示されている付属ファイルをお読みください。
ファイルエクスプローラー
2 ファイルSKILL.md を表示中
SKILL.md
ソースの指示 · 読み取り専用プレビュー- name
- good-docs-audit
- description
- 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, or check the voice and tone of documentation or text. Produces a structured findings report (file:line, rule violated, offending text, suggested rewrite) and does NOT edit files unless explicitly asked.
# Good docs audit
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:
- Read `good-docs-writing` (and its `references/style-guide.md`) first. Those rules are the rubric; this skill is the process.
- Cite `file:line` for every finding and quote the exact offending text.
- Give a real rewrite in the target voice, not "consider revising."
- Don't invent violations. A short report is a good outcome.
GitHubで見る