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.
How do I install this agent skill?
npx skills add https://github.com/composiohq/composio --skill good-docs-auditIs this agent skill safe to install?
- Gen Agent Trust Hubpass
The skill is a documentation auditing tool designed to review prose against a style guide. It operates locally on provided text files, enforces a structured reporting format, and contains no malicious code, unauthorized network operations, or persistence mechanisms.
- Socketpass
No alerts
- Snykfail
Risk: HIGH · 1 issue
What does this agent skill do?
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 itsreferences/style-guide.md) first. Those rules are the rubric; this skill is the process. - Cite
file:linefor 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.
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/composiohq/composio/good-docs-audit">View good-docs-audit on skillZs</a>