agentleFS
Curious-KeeperCurious-Keeper/skills/how/SKILL.md

how

Skill1 starsChanged 57 days agoMITView on GitHub

Explain how a subsystem actually works: its runtime flow, the mental model a maintainer needs, and which module owns what. Use when the user asks how something works, wants a walkthrough before changing code, or asks a placement question such as where something should live, which package owns it, or whether it is at the right layer.

90 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use setup-pstack, ketchup-video 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.
  • bnemaSkill

    setup-pstack

    Configure which Pi models pstack uses per role. Detects available provider/model specs and writes pstack's user configuration. Use for /setup-pstack, "configure pstack models", or changing pstack model choices.

    Also in 25 projects that use this

  • tristanphvnSkill

    ketchup-video

    Catch the user up like /keel:ketchup, with a short silent 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

  • ianclearySkill

    principle-explain-the-number

    Apply before you trust, report, or act on a number you measured: a speedup, a regression, a throughput, a latency, or an eval result. Find what limits it, and rule out that it measured something other than the work you think.

    Also in 28 projects that use this

  • ianclearySkill

    poteto-help

    Guides users through pstack setup, /poteto-mode, and picking the skill, playbook, or principle for a task. Type /poteto-help with a question.

    Also in 14 projects that use this

  • eryzerzSkill

    make-bot-ui

    Use when building a custom UI (page, dashboard, buttons) that should wake a Grok Bot over a webhook, when the user must provide a webhook sender key, or when exposing that UI on Tailscale.

    Also in 19 projects that use this

  • drafaelSkill

    in-your-own-words

    Restate the user's goals and the problem they are trying to solve to check understanding. Manual invocation only; use when the user explicitly invokes in-your-own-words or requests this understanding check. Do not solve the task or rewrite the assistant's last answer.

    Also in 26 projects that use this

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 89 edited versions we read keep these.

  • 3

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Read the cheap sources before spending a single sub-agent:

    line 32
  2. Distinctive:

    Every explorer returns citations or says it found nothing.

    line 46
  3. Very specific:

    Do this yourself, in the main thread, after the explorers return.

    line 52
  4. Distinctive:

    Never invent a caller, a function, or an API: If you cannot find the next hop, the trace stops there and you say where it stopped.

    line 56

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

Explain how a part of this codebase works, grounded in a path you actually traced. The deliverable is a mental model a maintainer can hold, not a tour of file names.

Naming the files is not grounding. A walkthrough that lists auth/session.ts and auth/middleware.ts and asserts that one calls the other reads exactly the same whether or not it is true. Trace one real path end to end and cite it.

This is not recall, which rebuilds what you were recently doing. It is not research, which reads primary sources outside the repo. It is not code-review, which judges a diff against a bar. This skill answers what the code in front of you does, and where a new piece of it belongs.

The three questions

Classify the question before you start, because each one ends somewhere different.

  • Flow. What happens when X occurs? Ends in a traced path: entry point, each hop, the state each hop reads and writes, where it terminates.
  • Mental model. How should I think about this subsystem? Ends in the handful of concepts and invariants that make the rest of the code predictable, plus the places the model leaks.
  • Placement. Where should this live, which module owns it, is this the right layer? Ends in a named owner and the seam that justifies it.

For a placement question, call the Skill tool for codebase-design first and answer in its vocabulary. "Where should this live" is a question about depth and seams, and answering it in ad-hoc words is how a module ends up shallow.

1. Scope the question

Pin what the user is asking about and which of the three questions it is. Say the classification back in one line, because a flow answer to a placement question is a wasted run.

Pin the boundary too. "How does auth work" is unanswerable; "how does a request get from the edge to an authenticated user object" is a path. Narrow it yourself and state the narrowing.

2. Ground from what the repo already documents

Read the cheap sources before spending a single sub-agent:

  • In a repo with a docs/app-maps/APP_MAP.json, its architecture section, its invariants.items, and its evolutionTraps.items for the area. An invariant is a rule that has already caused a real bug here, and a trap is something that used to be true. Both are load-bearing for a mental model and neither is visible in the code.
  • CONTEXT.md files and ADRs for the vocabulary the codebase actually uses. Use those terms; do not coin new ones.
  • The project's anchors in .claude/harness.config.json. The commands the project trusts tell you which behaviour it considers worth guarding.

Where these contradict the code, the code wins and the contradiction is a finding. Say so.

3. Fan out explorers

Spawn read-only sub-agents in parallel, one per slice of the question, on a fast model. Slice by hop for a flow question, by module for a mental model, by candidate owner for a placement question.

Build each prompt from references/explorer-prompt.md. Paste the grounding from step 2 into it rather than citing the paths: an explorer on another vendor's model cannot read this repo. Take reviewers from interrogate.reviewers, then models.roles.reviewer, the same way interrogate does. With neither field configured, use whatever the host defaults to.

Every explorer returns citations or says it found nothing. A search that finds nothing is a real answer and you need it, because it is what separates "nothing else calls this" from "I did not look."

For one or two slices, skip the fan-out and read directly. The raw file contents stay in the sub-agents; the main thread takes their findings.

4. Trace one real path

Do this yourself, in the main thread, after the explorers return. Pick the single most representative path and walk it hop by hop, opening each file. At every hop record the file:line, what it does, and the state it reads or writes.

Two rules bind this step:

  • Never invent a caller, a function, or an API. If you cannot find the next hop, the trace stops there and you say where it stopped.
  • Follow what a symbol search misses. The trace is only worth having where grep stops: a string key, a route table, dependency injection, an event name, a database column, a wire format, a feature flag, a generated file, or another language reading the same bytes.

Where the trace contradicts an explorer, trust the trace and note the correction.

5. Explain it

Build the answer from references/explainer-prompt.md and write it through the unslop skill.

Lead with the model, not the tour. A reader who stops after the first paragraph should still come away with the one idea that makes the rest predictable.

Output contract

  • The model. What a reader who stops here needs to predict the rest: the concepts and invariants, nothing else.
  • The path. The traced hops in order, each with a real file:line and what it does. For a placement question, the candidate owners with the seam each one implies.
  • Where the model leaks. The special cases, the hop that is not where you would expect it, the thing the names lie about.
  • Unknowns. What you could not establish, and where the trace stopped. Never pad this into certainty.
  • The answer. One paragraph answering the question as asked. For a placement question, name one owner and say why.

Anything the repo should have told you but did not is worth writing down. A missing invariant belongs in invariants.items, a stale assumption in evolutionTraps.items, and a term the code uses but nothing defines belongs in a CONTEXT.md via domain-modeling. Offer the edit; do not make it as a side effect of answering a question.

Reply: the answer, to the contract above.

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.

Reviews can't be read right now.

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.