@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

  1. 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.
  2. Layer, don't dump. Progressive disclosure: TL;DR → Example → Explanation → Deep Dive. Each layer is complete and accurate on its own.
  3. 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.
  4. Every word earns its place. If removing a word changes nothing, remove it. Active voice. Plain language. Short sentences. Scannable structure.
  5. 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.
Installs
–
GitHub Stars
1
First Seen
–
@tank/crystal-clear-docs — tankpkg/packages