agentleFS
serhiilenivserhiileniv/ccs/skills/explain/SKILL.md

explain

Skill0 starsChanged 10 days agoMITView on GitHub

Generate a standalone HTML study guide explaining a finished piece of work (bug fix, PR, feature) so the user can fully own it — context first, concept before details, guided code reading, interview-ready summary.

122 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use debug-fix, resolve-conflicts and 9 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

  • 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

  • abdullah1854Skill

    pr-summary

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

7 rules. 0 are common, 5 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 108 edited versions we read keep these.

  • 5

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    If $ARGUMENTS names a target (PR URL, issue number, commit range, file, or a topic like "the openclaw memory fix"), that is the subject.

    line 17
  2. Distinctive:

    Never explain from memory alone.

    line 28
  3. Distinctive:

    If explaining someone else's code rather than a change, read the entry points and callers before writing anything.

    line 35
  4. Very specific:

    Start from example.html — a finished guide built to this contract.

    line 44
  5. Distinctive:

    Never git add the guide, and never write it into a checkout with staged or in-flight PR work.

    line 58
  6. Distinctive:

    Default to the SIMPLE register defined in STYLE.md.

    line 60
  7. Distinctive:

    After writing, tell the user the file path and give a one-paragraph map of the guide's sections.

    line 65

“Common” is measured: kept by at least 6 in 10 of the 108 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

/ccs:explain — study-guide generator

Produce a standalone HTML study guide that lets the user own a piece of work: explain it to a reviewer, defend it in an interview, or re-load it into their own head months later.

1. Resolve scope

  • If $ARGUMENTS names a target (PR URL, issue number, commit range, file, or a topic like "the openclaw memory fix"), that is the subject.
  • Language: write in Ukrainian (<html lang="uk">) only if $ARGUMENTS carries an explicit lang: uk or a standalone uk token. A uk inside a word (duke, uk-locale) is part of the subject, not a language flag. Otherwise write in English.
  • With no arguments: the subject is the main piece of work completed in this session. If the session contains no substantive work, ask the user what to explain — do not invent a subject.

2. Gather facts before writing

Never explain from memory alone. Read the actual final state:

  • the diff / final code (git diff, git show, Read on the touched files),
  • the PR and issue text when a PR is involved (gh pr view, gh issue view),
  • the tests that lock the behavior,
  • review feedback that shaped the result (it often contains the best "twist" story).

If explaining someone else's code rather than a change, read the entry points and callers before writing anything.

3. Write the guide

  • Structure and voice: follow STYLE.md exactly — the fixed Part order (know-first concepts → intuition → the idea → the twist → the code → glossary → defend-it), the signaling rules (lead lines, sticky Part nav, boxes), "Plain English:" translations, and the self-check questions.
  • Start from example.html — a finished guide built to this contract. Keep its <head>, CSS, Part nav and closing <script> verbatim; put the guide's title in the nav's .name and replace the hero and the content inside .wrap. Copy its shape, length and register; ignore its subject. One self-contained file (inline CSS and JS, no external requests).
  • File name: <short-topic>-study-guide.html (kebab-case topic).
  • Location. The test is: could this file end up in a diff the user sends upstream? If yes, it goes elsewhere. Resolve in order:
    1. Beside existing *-study-guide.html files, if the user keeps any — that is already their shelf.
    2. Else, if the explained code lives in a repo the user contributes to rather than owns (a fork, an upstream remote, an open PR), write to a study-guides/ directory beside that repo root — outside its working tree.
    3. Else (the user's own project), the project root is fine. Never git add the guide, and never write it into a checkout with staged or in-flight PR work.
  • Default to the SIMPLE register defined in STYLE.md. If the user later says "simplify", rewrite the SAME file simpler — don't create a second file.

4. Close the loop

After writing, tell the user the file path and give a one-paragraph map of the guide's sections. Offer to simplify further or produce the other language on request. Then write the report (below).

Outcome: success = guide written · partial = written, then rewritten on request · failed = not written.

Report

Last step, every run, whatever the outcome: write .ccs/reports/<skill>/<YYYY-MM-DD>-<slug>.md at the repo root, and add .ccs/ to .git/info/exclude if missing. One line per field, no secrets, tokens or customer data. Print the path.

---
skill: <skill>
date: <YYYY-MM-DD>
repo: <owner/name>
target: <argument, one line>
outcome: success | partial | failed
learned: false
---

Used: <tools, CLIs, MCPs, files that did the work>
Found: <the result, one or two lines>
Friction: <what slowed or blocked it; a user correction; "none">

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.