Skip to main content

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.

Source facts

Repository
ComposioHQ/composio
Last source activity
July 30, 2026 at 12:31
Detected SKILL.md language
English
Stars
30,579
Forks
4,853

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

File Explorer
2 files

Showing SKILL.md

SKILL.md
Source instructions · Read-only preview
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.
View on GitHub