reviewing-documentation

Installation
SKILL.md

Reviewing documentation

When to apply

  • Reviewing .md files, skills (SKILL.md), rules, AGENTS.md, or similar instructional docs
  • Answering whether documentation reads well or meets quality expectations
  • Suggesting edits before merge or publication

Authoring standards (full detail): writing-documentation. This skill turns those expectations into a review workflow.

Review workflow

  1. Identify doc type — User guide, reference, skill, rule, changelog, etc. Apply type-appropriate expectations (e.g. skills need frontmatter and progressive disclosure).
  2. Read the full document (or the changed sections if the user scoped a diff). Note audience and purpose.
  3. Run the checklist below. Cite concrete locations (headings, bullets, or short quotes) when flagging issues.
  4. Deliver feedback using the output format in the next section.

Checklist (aligned with writing-documentation)

Related skills
Installs
4
First Seen
Mar 25, 2026