agentleFS
ccomkhjccomkhj/skills/step-by-step/SKILL.md

step-by-step

Skill10 starsChanged 19 days agoMITView on GitHub

Break a subject into meaningful grouped blocks and explain each at technical and intuitive levels with source references. Use when the user wants a codebase, document, problem, or process explained step by step, as a hierarchy, or at both expert and beginner level.

4 other projects use a version of this.

Adopted by

Most recently taken up by

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 4 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:

    Start with a concise whole-system overview and group map.

    line 12
  2. Distinctive:

    Keep explanations concise by default.

    line 18
  3. Distinctive:

    When useful, present the explanation as an interactive HTML artifact in Claude Code.

    line 23

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

Step by Step

Explain a codebase, document, problem, or process as an easy-to-scan hierarchy.

  1. Inspect the available source. Split the subject into meaningful blocks, then cluster related blocks into groups. Choose boundaries by purpose or mechanism; do not force equal sizes or confuse grouping with execution order.
  2. Start with a concise whole-system overview and group map.
  3. For every group and block, give adjacent explanations:
    • Technical: precise terminology for an engineer or scientifically literate reader; include important inputs, outputs, dependencies, files, and symbols when relevant.
    • Intuitive: explain the same idea so a ten-year-old could understand it, preferably with a concrete analogy. Map the analogy back to the technical concepts and avoid misleading simplifications.
  4. Attach evidence to the claims it supports. For code, cite verified path:Lx-Ly and symbols, and put a short verbatim excerpt beside the explanation: the few lines that carry the concept, with the rest trimmed to …, so the reader follows without opening files. For documents, cite available lines, pages, sections, paragraphs, or figures. Never invent source locations or excerpts. Label inference, uncertainty, and proposed behavior.
  5. Preserve important dependencies, branches, loops, parallelism, and handoffs. Keep group explanations as synthesis rather than repetition of their blocks.
  6. Keep explanations concise by default. Make the overview understandable without requiring the reader to inspect every block.
  7. Honor the user's requested output format. Otherwise choose a clear format appropriate to the environment and content.

Explain the subject, not private chain-of-thought.

When useful, present the explanation as an interactive HTML artifact in Claude Code.

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.