agentleFS
dominionismdominionism/Playbook/skills/research/SKILL.md

research

Skill0 starsChanged 2 months agoMITView on GitHub

Map a codebase or feature for confident work in the current session. Use when the user explicitly asks to research a repository; trace architecture, domain concepts, patterns, data flow, and relevant history without producing speculative documentation.

189 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use daily-arxiv, exp-eval 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.
  • LambenthanSkill

    daily-arxiv

    每日从 arXiv 拉取新论文,过滤相关性,auto-ingest 高优先级论文,检测 SOTA 更新

    Also in 5 projects that use this

  • LambenthanSkill

    exp-eval

    实验判决门:Review LLM 独立评判实验结果 → 4 种判决路径 → 自动更新 claims confidence、ideas status、graph edges

    Also in 5 projects that use this

  • truongtv22Skill

    Problem-Solving Techniques

    Apply systematic problem-solving techniques for complexity spirals (simplification cascades), innovation blocks (collision-zone thinking), recurring patterns (meta-pattern recognition), assumption constraints (inversion exercise), scale uncertainty (scale game), and dispatch when stuck. Techniques derived from Microsoft Amplifier project patterns adapted for immediate application.

    Also in 5 projects that use this

  • liufeng1976Skill

    setup-ts-deep-modules

    Wire dependency-cruiser into a TypeScript repo so each package is a deep module — implementation hidden in subfolders, reachable only through its entry-point files. User-invoked.

    Also in 43 projects that use this

  • skyllwtSkill

    exp-pilot-eval

    Pilot result evaluation — read pilot results, apply success criteria, update idea page (pilot_result, failure_reason if failed), generate PILOT_VERDICT_REPORT. Called by /ideate Phase 5 after /exp-pilot-run.

    Also in 4 projects that use this

  • skyllwtSkill

    exp-pilot-run

    Pilot experiment execution — read Pilot Spec YAML, write pilot code, run experiment(Confirm with the user before operation and require the applicant to conduct manual inspection), return results. Called by /ideate Phase 5. Does NOT modify wiki pages or judge pass/fail.

    Also in 4 projects that use this

  • +5 more from Lambenthan
  • +1 more from skyllwt

The file

We split this skill into the rules it gives an agent

11 rules. 0 are common, 6 are distinctive, and 5 are very specific to this project.

  • 0

    Common

    Most of the 169 edited versions we read keep these.

  • 6

    Distinctive

    This author's own choices. Worth a look.

  • 5

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    If the user provided a target, you are in specific mode.

    line 14
  2. Very specific:

    Read the top-level directory tree and package.json (or equivalent manifest).

    line 21
  3. Distinctive:

    Read these if they exist. Do not create them:

    line 27
  4. Distinctive:

    Read its tests to understand expected behavior and edge cases.

    line 44
  5. Distinctive:

    Comprehensive: write (or overwrite) the full file.

    line 54
  6. Very specific:

    Specific: update only the sections your deep-dive touched.

    line 55
  7. Distinctive:

    Keep it tight. Every sentence must be something you will reference later in this session.

    line 85
  8. Very specific:

    Prefer structural facts over narrative.

    line 86
  9. Distinctive:

    If you don't know something that matters, state it as an open question — don't guess.

    line 87
  10. Very specific:

    If the user has a task to build → /blueprint to plan the implementation, then /grill to sharpen the plan's terminology and capture ADRs.

    line 97
  11. Very specific:

    If a question needs to be seen, not discussed → /prototype to build a throwaway answer.

    line 98

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

Map this codebase so you can work in it with confidence for the rest of this session. Produce understanding, not documentation.

Mode

  • Comprehensive (no target given, or user says "full" / "everything"): map the entire project.
  • Specific (user names a feature, module, file, or area): deep-dive that target and only survey the rest.

If the user provided a target, you are in specific mode. If they didn't, ask: comprehensive or specific? One question only.


Scan

1. Structure

Read the top-level directory tree and package.json (or equivalent manifest). Identify:

  • The stack (framework, runtime, database, key dependencies)
  • The build/test/lint commands available
  • Whether a monorepo, and if so, which package is relevant

2. Existing knowledge

Read these if they exist. Do not create them:

  • README.md — project purpose and setup
  • Context/Glossary.md — domain language
  • Context/ADR/ — architectural decisions (read only the ones touching your target in specific mode)
  • .cursor/rules/ or similar — project conventions

3. Architecture (comprehensive) or target trace (specific)

Comprehensive:

  • Identify entry points (CLI, HTTP server, worker, cron — what starts this thing?)
  • Map major module boundaries: what directories own what responsibility, and how they import each other
  • Trace the primary data path: request → handler → service → store (or equivalent)
  • Identify cross-cutting concerns (logging, auth, error handling, config)

Specific:

  • Locate the target's files. Trace its imports — what does it depend on?
  • Trace its dependents — who calls it? Use lsp references on its exports.
  • Read its tests to understand expected behavior and edge cases.
  • Walk one complete execution path through the target end-to-end.

Synthesize

Build a mental model in scratch reasoning first — this is what you'll carry for the current session. Then write it to Context/Research/Research.md so future sessions can absorb it without re-researching.

Mode-specific behavior

  • Comprehensive: write (or overwrite) the full file. You now understand the entire project — capture everything.
  • Specific: update only the sections your deep-dive touched. Leave the rest intact. If no Context/Research/Research.md exists yet, create a minimal version covering what you explored.
  • Also check for topic files: after updating Research.md, scan Context/Research/ for any topic files (e.g. Research/Auth-Middleware-Chain.md) that overlap with your deep-dive target. If you found something that supersedes or refines a topic file, update or flag it. A deep-dive that contradicts a topic file is a finding — surface it as an open question.

File format

# Research: {Project Name}

> Last updated: YYYY-MM-DD (comprehensive) | YYYY-MM-DD — {target} deep-dive

## What is this?
{One sentence — the project's purpose}

## Architecture
{3-5 sentences — how the system is organized, primary data path, key boundaries}

## Domain Model
{Important entities and how they relate. Use terms from Context/Glossary.md if it exists.}

## Patterns
{Naming conventions, file structure conventions, testing patterns, error-handling style. Things you'd get wrong if you guessed.}

## Relevant ADRs
{Decisions that constrain what you can change. Only list the ones that exist and matter.}

## Open Questions
{Things you don't know that matter. "I did not trace the payment module — it's imported by billing but I haven't read it."}

Rules for the synthesis

  • Keep it tight. Every sentence must be something you will reference later in this session.
  • Prefer structural facts over narrative. "Auth lives in src/auth/, consumed by every route via middleware" not "The project has an authentication system which..."
  • If you don't know something that matters, state it as an open question — don't guess.
  • State your confidence boundary explicitly: "I did not trace the payment module — it's imported by billing but I haven't read it."

Workflow

Before this command: /init (to scaffold Context/ — run once per project). Otherwise none — /research is the entry point when entering a codebase cold.

After this command:

  • If the user has a task to build → /blueprint to plan the implementation, then /grill to sharpen the plan's terminology and capture ADRs.
  • If a question needs to be seen, not discussed → /prototype to build a throwaway answer.

State which is appropriate and why.

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.