Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
| 1 | --- |
| 2 | name: good-docs-audit |
| 3 | 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. |
| 4 | --- |
| 5 | |
| 6 | # Good docs audit |
| 7 | |
| 8 | 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. |
| 9 | |
| 10 | Read `references/audit-process.md` for the procedure, the prioritized violation checklist, the report format, and the reporting rules. |
| 11 | |
| 12 | Non-negotiables: |
| 13 | |
| 14 | - Read `good-docs-writing` (and its `references/style-guide.md`) first. Those rules are the rubric; this skill is the process. |
| 15 | - Cite `file:line` for every finding and quote the exact offending text. |
| 16 | - Give a real rewrite in the target voice, not "consider revising." |
| 17 | - Don't invent violations. A short report is a good outcome. |