write-docs

Installation
SKILL.md

Documentation Standard

All structured docs live under docs/. Each subdirectory is a category (e.g., docs/design/, docs/guides/, docs/troubleshooting/). Follow this standard when creating new docs or modifying existing ones.

Red Flag

Never:

  • Lead with analysis instead of the decision
  • Include implementation details that belong in code
  • Mix languages within one document
  • Silently delete history — mark superseded sections, don't erase them
  • Create a doc without adding it to the docs index
  • Mark a doc as current without verifying claims against code
  • Skip the Boundaries section in design docs — it's the core anti-drift mechanism
  • Use a duplicate number within a category

Frontmatter (Required)

Every managed doc MUST start with YAML frontmatter:

Installs
1
Repository
heliohq/ship
GitHub Stars
81
First Seen
Apr 22, 2026
write-docs — heliohq/ship