skills.rest
tankpkg
tankpkgOFFICIAL
Explore all skills by this author →
GitHub

@tank/crystal-clear-docs

Rewrite technical documents into layered HTML and Markdown with TL;DR summaries and Mermaid diagrams.

1|1|Updated Feb 20, 2026
Search Tags:#documentation#technical writing#progressive disclosure#mermaid diagrams#callouts#scannability#svg accessibility
One-click install
npx skills add https://github.com/tankpkg/packages --skill tank-crystal-clear-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: @tank/crystal-clear-docs
Source: https://github.com/tankpkg/packages/tree/main/skills/crystal-clear-docs
Command: npx skills add https://github.com/tankpkg/packages --skill tank-crystal-clear-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

It turns dense, hard-to-scan technical writing into documents people can understand quickly, from the first sentence to the deep dive.

Core Features & Use Cases

  • Layered explanations: Organize content from TL;DR to advanced detail so different readers can stop at the right depth.
  • Scannable document structure: Use strong headings, callouts, tables, and concise prose to make HTML and Markdown easier to read.
  • Diagram-first clarity: Add Mermaid or accessible SVG diagrams when a concept needs visual explanation, such as workflows, architecture, comparisons, or state changes.
  • Use case: Rewrite an overloaded API guide into a clear, progressive document with a summary, quick start, explanation, and diagram-backed deep dive.

Quick Start

Ask this Skill to rewrite your technical document into a clearer, layered version with a TL;DR, scannable structure, and a diagram-ready explanation.

Frequently Asked Questions about @tank/crystal-clear-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I make technical documentation easier to scan and read?▼

Rewrite technical documents with layered explanations, starting with a TL;DR and adding scannable structure, callouts, and concise prose to make dense HTML and Markdown instantly readable.

What is progressive disclosure in technical writing?▼

Progressive disclosure in technical writing organizes content from a TL;DR summary to advanced detail, allowing different readers to stop reading at the exact depth of information they need.

How do I add Mermaid diagrams to Markdown documentation?▼

You can add Mermaid diagrams to Markdown documentation to provide diagram-first clarity for workflows, architecture, comparisons, or state changes when a concept requires visual explanation.

Does this technical writing approach support accessible SVG diagrams?▼

Yes, this technical writing approach supports accessible SVG diagrams alongside Mermaid diagrams to ensure maximum readability and visual accessibility for complex architecture explanations.

What is the best way to rewrite an overloaded API guide?▼

The best way to rewrite an overloaded API guide is to restructure it into a progressive document featuring a clear summary, quick start section, explanation, and a diagram-backed deep dive.

Related Skills

Explore More Content & Communication Skills→
Kushal9889Kushal9889

writing-shape

Shape raw markdown notes into structured articles through conversation.

Community
Intermediate
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate
Camilo8902Camilo8902

mermaid-diagram-generator

Generates flowcharts, sequence diagrams, ERDs, and class diagrams using Mermaid syntax in Markdown.

Community
Basic
kurojskurojs
2

cognitive-doc-design

Restructure documentation to lead with answers and include verification checklists.

Community
Basic