Index of every page on this site: llms.txt
All skills
composiohq avatar

/good-docs-audit

@85dab73
by Composiocomposiohq/composio31k stars
4,962
Run it yourself

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.

Use this Skill: https://skilld.dev/gh/composiohq/composio/good-docs-audit

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈95 tokens for metadata: the name and description. ≈191 when used: this file. ≈945 more on demand in 1 file.

Description uses 4.8% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈381 characters, or 4.8%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

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.

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No alerts2d3 checks · Risk SAFE
  • Gen Agent Trust Hub2d

    The skill is a documentation auditing tool designed to review text against a style guide. It operates locally, reading documentation files and generating reports based on a predefined set of writing rules. No security issues such as data exfiltration, remote code execution, or unauthorized file access were detected.

  • Socket3mo

    No alerts

  • Snyk2d

    Risk: LOW · No issues

Signed by skilld at 85dab73. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 4 months ago

README badge

README badge for composiohq/composio/good-docs-audit