@tank/crystal-clear-docs
Installation
SKILL.md
Crystal Clear Docs
Create technical documents people actually read and understand — by layering information from TL;DR to deep dive and explaining hard concepts with diagrams.
Core Philosophy
- Lead with the answer. The reader's first question is "does this matter to me?" — answer it in the first sentence. Everything else supports that answer.
- Layer, don't dump. Progressive disclosure: TL;DR → Example → Explanation → Deep Dive. Each layer is complete and accurate on its own.
- Show, don't just tell. Concepts that require the reader to hold multiple relationships in their head get a diagram. Code gets shown before explanation.
- Every word earns its place. If removing a word changes nothing, remove it. Active voice. Plain language. Short sentences. Scannable structure.
- Respect the reader's time. They scan, they don't read. Design for scanning: information-dense headings, bold key terms, lists over walls of text, and callouts that surface what matters.