Skip to content
TrustedSkillsbeta
Back to all skills

Documentation Audit

Checked
troykelly·vlatest·writing

Helps with documentation, auditing as part of writing, documentation, and content creation workflows.

Repository

Install on your platform

Showing Claude Code. One command installs this skill into any of the agents below.

  1. 1

    Run this in your project

    terminal
    $ npx skills add troykelly/claude-skills --skill documentation-audit -a claude-code

  2. Uses the open-source skills CLI and needs Node.js. Add -g to install it for your user instead of this project.

What we know about this skill

Publisher

troykelly

Taken from the source listing. We haven't verified who controls this account.

Install target

Live repository

Not pinned. Installing fetches whatever the repository holds at the time you run the command.

No human has reviewed this code. The checks below are a static scan of the files at one commit — nobody has run this skill or judged whether it works. A skill runs with whatever access you give your agent, so read the source before you install it.

Automated safety checks

scanned

This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.

  • Declares what it does: passed

    SKILL.md parses and declares a name and a description.

    SKILL.md exists, its frontmatter parses, and it declares a name and a description.

  • No undeclared network calls: passed

    Makes no network calls.

    Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.

  • No obfuscated payloads: passed

    No encoded or obfuscated payloads.

    No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.

  • No credential access: passed

    Reads no keys, tokens, keychains or credential files.

    Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.

  • No pipe-to-shell installers: passed

    No pipe-to-shell or download-and-run installers.

    No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.

  • Pinned to a commit: passed

    Scanned troykelly/claude-skills at 38a2ecc528.

    The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.

Commit
38a2ecc528
Manifest
skills/documentation-audit/SKILL.md
Scanned
1 file, 328 lines
This is a static scan, not a review. It reads the skill's files; it does not run them, and it cannot tell you whether the skill is any good or whether the code does what its description says. A skill runs with whatever access you give your agent.
What each check looks for →

About this skill

What it does

The documentation-audit skill analyzes existing documentation to identify areas for improvement. It can assess for clarity, consistency, and completeness, ultimately helping to ensure documentation is user-friendly and accurate. The audit produces a report highlighting potential issues and suggesting revisions.

When to use it

  • Technical Writing Review: Evaluate internal technical documents (API references, SDK guides) before release.
  • Knowledge Base Optimization: Identify gaps or outdated information in a public knowledge base.
  • Onboarding Material Assessment: Ensure onboarding documentation is clear and effective for new users.
  • Content Consistency Check: Verify that terminology and style are consistent across multiple documents.

Key capabilities

  • Clarity assessment
  • Consistency checking
  • Completeness evaluation
  • Report generation with suggested revisions

Example prompts

  • "Audit this documentation for clarity and consistency: [paste document content]"
  • "Can you review these API docs and tell me what's missing? [paste document content]"
  • "Evaluate the completeness of this onboarding guide. [paste document content]"

Tips & gotchas

The quality of the audit depends heavily on the clarity and structure of the input documentation. Very large documents may require to be broken down into smaller chunks for optimal results.