Documentation Review

VerifiedSafe

Audit or improve general repository documentation against implemented behavior, in audit-only or authorized edit mode.

Sby Skills Guide Bot
DocumentationIntermediate
11/1/2026
Claude CodeCursorWindsurfCopilotCodex
#docs-audit#readme#verification#technical-writing#repo-maintenance

Recommended for

Automated summary

This skill audits or improves general repository documentation against implemented behavior, operating in either audit-only mode or authorized edit mode.

Strengths

  • Clearly separates read-only auditing from edits confined to a confirmed document set
  • Checks claims by running side-effect-free commands and examples, or by reading the code
  • Classifies findings into concrete actions: keep, update, merge, split, move, archive, or remove
  • Routes specialized documentation work to dedicated skills instead of broadening the request

Limitations

  • Does not cover specialized documents such as specs, critical journeys, change drift, or marketing claims
  • Running examples depends on commands being read-only or executable in a scratch directory
  • Archiving, removal, or major expansion require explicit authority, which can slow large overhauls
When to use it

Use it to audit a README or general documentation set, or to correct their accuracy against real code, configuration, and commands.

When not to use it

Avoid it for updating a spec, documenting critical journeys, handling drift from a recent change, or revising marketing claims.

Security analysis

Safe
Quality score86/100

The skill is purely an editorial/audit workflow: it declares no tools, requests no credentials, touches no network or destructive operations, and explicitly forbids inventing facts or broadening scope. The only execution-adjacent instruction is running documented examples for verification, which is scoped to read-only or scratch-directory runs and is a standard documentation-QA practice rather than an exfiltration or destructive pattern. No prompt-injection or role-manipulation attempts appear in the content.

Findings
  • •Step 3 instructs the agent to execute documented commands/examples to verify them; this is a legitimate but non-trivial action, partially mitigated by the constraints to read-only or scratch-directory execution. If adopted, agents should treat commands found in untrusted repo docs with normal sandboxing caution.
How this analysis is made

Examples

Audit README accuracy
Audit the README and docs/ folder against the actual CLI commands, config options, and examples in this repo. Report prioritized, evidence-backed findings only — do not edit anything.
Fix setup docs
Update the install and setup sections of README.md and docs/setup.md so they match current behavior. Keep the existing structure and voice, and don't touch other documents.
Tidy contributor docs
Review the contributor documentation and tell me which pages to keep, merge, move, or archive, citing evidence from the code and existing docs.

name: docs-review description: Audit or improve general repository documentation against implemented behavior. Use for deliberate README or documentation-quality work not owned by a more specific documentation skill.

Documentation Review

Own general repository-document quality in an explicit audit-only or authorized edit mode.

Workflow

  1. Confirm audience, document set, desired outcome, and whether the task authorizes edits.
  2. Route current-change drift to docs-drift-review, docs/context/ structure to repo-context-document, semantic contracts to spec-update, journeys to critical-journey-document, and persuasive claims to marketing-claims-review.
  3. Verify content against implementation, commands, configuration, examples, tests, metadata, and canonical documents. Run documented commands and examples when they are read-only or can run in a scratch directory, because an example that does not run is the defect readers hit first. Read the code for the rest, and say which claims you ran and which you only read.
  4. Classify evidence-backed findings as keep, update, merge, split, move, archive, or remove.
  5. In audit-only mode, return prioritized findings without edits.
  6. In edit mode, change only the confirmed document set and preserve repository structure and voice unless that structure is the requested defect.
  7. Use text-improve on changed prose without changing verified facts, required terminology, or intentional voice.
  8. Require explicit authority before archiving, removing, or materially expanding the document set.

Do not invent features, commands, architecture, benchmarks, screenshots, promises, or roadmap items; impose a generic template; or broaden a focused request.

Finish with an evidence-backed audit or verified scoped edits, plus unresolved facts that need an owner.

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/documentation-review-mvda897f/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/documentation-review-mvda897f' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/documentation-review-mvda897f/download' --output '.skill-downloads/documentation-review-mvda897f/SKILL.md.part' && mv '.skill-downloads/documentation-review-mvda897f/SKILL.md.part' '.skill-downloads/documentation-review-mvda897f/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code
test -f '.skill-downloads/documentation-review-mvda897f/SKILL.md' && test -s '.skill-downloads/documentation-review-mvda897f/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/docs-review' && cp -R '.skill-downloads/documentation-review-mvda897f' '.claude/skills/docs-review'

Cursor
test -f '.skill-downloads/documentation-review-mvda897f/SKILL.md' && test -s '.skill-downloads/documentation-review-mvda897f/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/docs-review' && cp -R '.skill-downloads/documentation-review-mvda897f' '.cursor/skills/docs-review'

Codex
test -f '.skill-downloads/documentation-review-mvda897f/SKILL.md' && test -s '.skill-downloads/documentation-review-mvda897f/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/docs-review' && cp -R '.skill-downloads/documentation-review-mvda897f' '.agents/skills/docs-review'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/documentation-review-mvda897f'

openskills read 'documentation-review-mvda897f'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/documentation-review-mvda897f/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills