Docs Review

Reviews documentation for voice, style, and structure alignment with Outfitter standards. Use when reviewing docs, checking content quality, or when "review this doc", "voice check", "style review", or "is this ready?" are mentioned.

outfitter-dev 366aa50 1.3 KB Updated

File contents

Documentation Review

Review the current document against Outfitter standards for voice, style, and structure.

Review Direction

$ARGUMENTS

If direction is provided above, focus on that specific aspect. Otherwise, perform a general review across all dimensions.

Review Criteria

Voice

Does it sound like Outfitter?

  • Confident, opinionated stance
  • Agents as first-class consumers
  • Plain language over jargon

Style

Is the craft right?

  • Punch-and-flow rhythm (short + long sentences)
  • Earned enthusiasm (backed by substance)
  • Strong opening and closing

Structure

Does it follow documentation patterns?

  • Appropriate template usage
  • Complete, runnable examples
  • Correct heading hierarchy (h1 > h2 > h3)

Output Format

Provide your review in this format:

Status: Ready | Needs Work

Summary: One sentence overall assessment.

Issues (if any):

  • [Location] Issue description and suggested fix

Strengths:

  • What works well

If the document is ready, say so briefly. If it needs work, be specific about locations and fixes.

outfitter-dev/agents-internal/tree/main/internal/skills/docs-review commit 366aa50061

Frequently asked questions

npx skillmds@latest add outfitter-dev/docs-review