agentleFS
ShahriarBijoyShahriarBijoy/show-me-how/skills/explain/SKILL.md

explain

Skill0 starsChanged 3 months agoMITView on GitHub

Explain a feature, module, or concept from this repo as a storybook — as many mascot panels as the topic needs, with captions — shown in chat and saved under docs/show-me-how/<topic>/<topic>.md.

122 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use debug-fix, root-cause and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • zebbernSkill

    debug-fix

    Find and fix a bug or issue — from any source (GitHub issue, error message, user report, or observed behavior)

    Also in 3 projects that use this

  • Ingramradical235Skill

    root-cause

    Structured root cause analysis using WHERE (MECE decomposition) then WHY (causal structure diagrams) pipeline. Includes coin-flip detection, logical-leap detection, and vicious cycle intervention. Use when buffer enters YELLOW/RED, when metrics stall, or when Actions execute but don't produce results.

    Also in 5 projects that use this

  • ralphkraussSkill

    resolve-conflicts

    Resolve git merge conflicts or re-apply changes from a stale branch onto current main. Use when user says "resolve conflicts", "merge conflicts", "rebase branch", "branch is behind", "re-apply changes", "port branch", or a branch is too far behind main to merge cleanly.

    Also in 4 projects that use this

  • neurofooSkill

    socratic

    Socratic questioning to examine beliefs, uncover assumptions, and develop deeper understanding. Use to challenge thinking, evaluate proposals, or teach without lecturing.

    Also in 4 projects that use this

  • anombyte93Skill

    discover

    Phase 1 of the prd-taskmaster pipeline: brainstorm-driven discovery. Delegates to superpowers:brainstorming in Interactive Mode (one adaptive question at a time), or self-brainstorms in Autonomous Mode when no user is present. Intercepts before the brainstorming chain hands off to writing-plans — this skill owns the exit. Extracts constraints, calibrates scale (Solo / Team / Enterprise), and advances the pipeline to GENERATE.

    Also in 6 projects that use this

  • mitsuhikoSkill

    summarize

    Fetch a URL or convert a local file (PDF/DOCX/HTML/etc.) into Markdown using `uvx markitdown`, optionally it can summarize

    Also in 8 projects that use this

The file

We split this skill into the rules it gives an agent

3 rules. 0 are common, 3 are distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 109 edited versions we read keep these.

  • 3

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Read the top 5 files, or just the relevant sections of larger ones.

    line 15
  2. Distinctive:

    If nothing matches, tell the user exactly what you searched (the terms and the globs) and ask them to point at a file or folder instead.

    line 16
  3. Distinctive:

    Write BRIEF (<=200 words): what it is, who uses it, the ideas a newcomer must get (as many as the topic really has), the one gotcha.

    line 20

“Common” is measured: kept by at least 6 in 10 of the 109 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

/show-me-how:explain $ARGUMENTS

TOPIC = "$ARGUMENTS". If empty, ask the user for a topic and stop — do not guess one.

1. Gather (read-only, at most 5 files)

  1. Grep the repo for the topic words (case-insensitive) across *.md, docs/, and code files (*.ts, *.tsx, *.js, *.mjs, *.py, *.go, *.rs, *.java, *.cs, *.rb, *.php), excluding node_modules, dist, build, .git, .superpowers/, **/plans/, **/specs/, and *-report.md — planning and report files describe work about the topic, not the topic. Grep only — never edit or write during this step.
  2. Rank hits: primary key is path relevance, in this order: README > docs/ > ADR > entry points > everything else; tie-break by number of matching lines per file (descending).
  3. Read the top 5 files, or just the relevant sections of larger ones. Record each path read as SOURCES.
  4. If nothing matches, tell the user exactly what you searched (the terms and the globs) and ask them to point at a file or folder instead. Stop.

2. Brief

Write BRIEF (<=200 words): what it is, who uses it, the ideas a newcomer must get (as many as the topic really has), the one gotcha.

3. Illustrate

Invoke the illustrate skill (skills/illustrate/SKILL.md) from its step 0, with this brief block:

MODE: explain
TOPIC: <TOPIC>
SOURCES: <the paths from step 1.3>
BRIEF: <the text from step 2>
MAX_IMAGES: 8

Illustrate prints the finished storybook in chat and saves it as <docs>/<slug>/<slug>.md; do not duplicate its output.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.