Skip to content

FLEXIBLE

Documentation Review Checklist

Gate mode: FLEXIBLE (auto-advance, async review)

README.md

  • [ ] Has a clear one-line project description
  • [ ] Quick-start instructions use real commands that work from project root
  • [ ] Prerequisites list actual runtime requirements with versions
  • [ ] Features list matches actual project capabilities
  • [ ] Tech stack table is accurate
  • [ ] Project structure tree matches actual directory layout
  • [ ] No placeholder text or unfilled template sections

Setup Guide (docs/setup.md)

  • [ ] Installation steps produce a running environment
  • [ ] Environment variables documented with descriptions
  • [ ] Database setup instructions are complete (if applicable)
  • [ ] All referenced scripts and commands exist

Architecture Overview (docs/architecture.md)

  • [ ] Component diagram or description matches actual codebase
  • [ ] Data flow description is accurate
  • [ ] Technology choices listed match actual stack
  • [ ] Directory structure matches reality

API Reference (docs/api.md)

  • [ ] All public endpoints are documented
  • [ ] Request/response examples use realistic data
  • [ ] Authentication method is accurately described
  • [ ] Error codes match actual API behavior

General Quality

  • [ ] All code examples are syntactically valid
  • [ ] All internal links between docs resolve correctly
  • [ ] Consistent terminology across all documentation
  • [ ] No contradictions between docs
  • [ ] No TODO markers or placeholder text remaining
  • [ ] Managed section tags (<!-- sniper:managed -->) are properly formed
  • [ ] Documentation is concise — no filler or marketing language