explanation-docs

Solid

Explanation documentation patterns for understanding-oriented content - conceptual guides that explain why things work the way they do

AI & Automation 61 stars 8 forks Updated today Apache-2.0

Install

View on GitHub

Quality Score: 90/100

Stars 20%
60
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Explanation Documentation Skill This skill provides patterns for writing effective explanation documents. Explanations are understanding-oriented content for readers who want to know why things work the way they do. ## Purpose & Audience **Target readers:** - Users who want to understand concepts deeply, not just use them - Architects and technical leads evaluating design decisions - Team members onboarding to a codebase or system - Anyone asking "why?" or "how does this work?" **Explanations are for reading away from the keyboard.** Unlike tutorials or how-to guides, readers aren't trying to accomplish a task while reading. They're building mental models. **Explanations are NOT:** - Tutorials (which teach through hands-on doing) - How-To guides (which accomplish specific goals) - Reference docs (which look up precise details) ## Explanation Document Template Use this structure for all explanation documents: ```markdown --- title: "[Concept/System Name] Explained" description: "Understand how [concept] works and why it was designed this way" --- # Understanding [Concept] Brief intro (2-3 sentences): What this document explains and why it matters. Set expectations for what the reader will understand after reading. ## Overview High-level summary of the concept. What is it? What problem does it solve? This should be understandable without deep technical knowledge. ## Background and Context ### The Problem What situation or challenge led to this design? What were...

Details

Author
existential-birds
Repository
existential-birds/beagle
Created
5 months ago
Last Updated
today
Language
Shell
License
Apache-2.0

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Listed

code-explanation

Use when explaining code, concepts, or system behavior to a specific audience level - provides a structured explanation workflow with depth control and validation steps.

15 Updated 2 days ago
NickCrew
AI & Automation Listed

explain_concept

Use this skill when the user wants to understand a concept, technology, pattern, or principle — not to produce code right now, but to genuinely understand something. Triggers on: "explain X to me", "how does X work?", "what is X?", "I don't understand Y", "can you walk me through Z?", "what's the difference between A and B?", "why do people use X?", "when should I use X vs Y?". This skill shifts the focus from code output to clear, accurate, educational explanation tailored to the user's level.

0 Updated yesterday
feralbureau
AI & Automation Solid

explain

Explain code, concepts, or system behavior with adjustable depth levels

4,608 Updated 2 days ago
FlorianBruniaux
AI & Automation Solid

code-documentation-code-explain

You are a code education expert specializing in explaining complex code through clear narratives, visual diagrams, and step-by-step breakdowns. Transform difficult concepts into understandable explanations for developers at all levels.

39,350 Updated today
sickn33
Data & Documents Listed

code-documentation-code-explain

You are a code education expert specializing in explaining complex code through clear narratives, visual diagrams, and step-by-step breakdowns. Transform difficult concepts into understandable explanations.

335 Updated today
aiskillstore