documentation

Maintain accurate READMEs, setup guides, API specifications, ADR records, and verification reports.

SKILL.md

GitHub

Technical Documentation

Documentation Standards

  • Truthful Status: Clearly distinguish what is implemented and verified vs what is roadmap or estimated.
  • Copy-Paste Verifiability: Provide complete, working CLI commands with expected outputs.
  • Architecture Diagrams: Mermaid diagrams representing state transitions, control loops, and component topologies.
  • Decision Records: Document significant technical trade-offs, rejected alternatives, and invariants in DECISIONS.md.