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.

Informations de source

Dépôt
ComposioHQ/composio
Dernière activité de la source
30 juillet 2026 à 12:31
Langue détectée de SKILL.md
anglais
Étoiles
30 500
Forks
4 849

Options d'installation

Le prompt qui vérifie d'abord la source est sélectionné par défaut. Vous pouvez passer à une commande directe ou télécharger une copie locale.

Vérifiez les fichiers source

Lisez SKILL.md et les fichiers associés affichés par SkillsMP avant de décider de l'installer.

Explorateur de fichiers
2 fichiers

Affichage de SKILL.md

SKILL.md
Instructions source · Aperçu en lecture seule
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.
Voir sur GitHub