agentleFS
dsebbandsebban/skills/skills/how/SKILL.md

how

Skill71 starsChanged 27 days agoMITView on GitHub

Use for \"how does X work\", code walkthroughs before changing something, and placement / ownership / layering questions (\"where should this live\", \"which package owns this\", \"is this the right layer\"). Explains subsystem architecture, runtime flow, onboarding mental models. Use why for motivation.

102 other projects use a version of this, 58 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use ketchup-video and statechart.

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.
  • tristanphvnSkill

    ketchup-video

    Catch the user up like /keel:ketchup, with a short subtitled video of slides for what happened and the waiting calls as text under it. Use for /keel:ketchup-video.

    Also in 13 projects that use this

  • TheOnlyFusionCubeSkill

    statechart

    Draw what an app's user sees as a Mermaid statechart from a TLA+ model. States are gray if they work, red if still wrong, and green if fixed. Each bug TLC finds is a numbered path. Use for /statechart, \"show the PM the bug\", or to turn an agreed chart into a TLA+ skeleton.

    Also in 16 projects that use this

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 101 edited versions we read keep these.

  • 2

    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:

    If the scope is ambiguous, state your interpretation and explore.

    line 17
  2. Distinctive:

    When in doubt, take the simple path.

    line 22

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

How

Explore the codebase to answer "how does X work?" questions. Produce architectural explanations at the level of a senior engineer onboarding onto a subsystem, enough to build a working mental model, not so much that it reads like annotated source code.

Every spawn is an item in the task tool's batch shape, and every child is read-only by its brief. Explorers use agent: scout. Every explainer uses agent: reviewer. A task item never names a model. Each agent's model comes from task.agentModelOverrides and modelRoles in ~/.omp/agent/config.yml, which /skill:setup-pstack (skill://setup-pstack) writes. Set an item's effort for the job only when the task schema shows an effort field (task.enableEffort). Otherwise omit it.

Each dispatch is one task call. context holds the question and the subsystem scope every child shares. tasks[] holds one item per child with name (unique, CamelCase), agent, task (the filled prompt template), and solutionSpace. Children never call task, never ask the user, and return their result to you. Read each full result at agent://<id>.

1. Assess complexity

If the scope is ambiguous, state your interpretation and explore. The user can redirect.

  • Simple (a single module, a small utility, a narrow question such as "how does function X work"): no explorers. Spawn one explainer that explores and explains in one pass, built from skill://how/references/explainer-prompt.md without the explorer-findings section. Go to step 4.
  • Complex (a subsystem spanning multiple files or services, a cross-cutting feature, a full architectural overview): go to step 2.

When in doubt, take the simple path.

2. Explore (complex only)

Decompose the question into 2 to 4 angles, each a distinct slice of the subsystem. Start all explorers in a single task call, each with skill://how/references/explorer-prompt.md and its angle filled in.

{
  "context": "Question: how does request routing work in the gateway? Repository at the current workspace. Read-only exploration.",
  "tasks": [
    {
      "name": "ExplorerMatching",
      "agent": "scout",
      "task": "<explorer prompt with the route-matching angle filled in>",
      "solutionSpace": "one angle given, which files to read and how deep to trace are open"
    },
    {
      "name": "ExplorerMiddleware",
      "agent": "scout",
      "task": "<explorer prompt with the middleware-chain angle filled in>",
      "solutionSpace": "one angle given, which files to read and how deep to trace are open"
    }
  ]
}

3. Synthesize (complex only)

Once all explorers have returned, spawn one explainer with skill://how/references/explainer-prompt.md and every explorer's findings filled in. When the findings run long, write each to local://how-<angle>.md and pass the paths.

4. Present

Present the explainer's output. Light edits for clarity or context from the conversation are fine. Do not substantially rewrite it.

Output format

The explanation uses the sections defined in skill://how/references/explainer-prompt.md, dropping any that do not apply: Overview, Key Concepts, How It Works, Where Things Live, Gotchas.

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.