# Good Docs Audit

Audit a doc, guide, README, or block of prose against the good-docs-writing style guide...

- Repository: https://github.com/ComposioHQ/composio (30865 stars)
- Category: Writing
- License: MIT
- Last updated: 2026-11-01
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add ComposioHQ/composio --skill good-docs-audit -g -a claude-code -y`
Codex: `npx skills add ComposioHQ/composio --skill good-docs-audit -g -a codex -y`
Cursor: `npx skills add ComposioHQ/composio --skill good-docs-audit -g -a cursor -y`
Gemini CLI: `npx skills add ComposioHQ/composio --skill good-docs-audit -g -a gemini-cli -y`

## 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.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# 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.