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.

Informações da origem

Repositório
ComposioHQ/composio
Última atividade na origem
30 de julho de 2026 às 12:31
Idioma detectado do SKILL.md
inglês
Estrelas
30.500
Forks
4.849

Opções de instalação

Por padrão, está selecionado o prompt que primeiro revisa a origem. Você pode mudar para um comando direto ou baixar uma cópia local.

Revise os arquivos de origem

Leia o SKILL.md e os arquivos complementares exibidos pelo SkillsMP antes de decidir se vai instalar.

Explorador de arquivos
2 arquivos

Exibindo SKILL.md

SKILL.md
Instruções da origem · Visualização somente leitura
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.
Ver no GitHub