agentleFS
SWEStashSWEStash/swe-workflow-skills/skills/research-methodology/SKILL.md

research-methodology

Skill1 starsChanged 5 days agoMITView on GitHub

Run DS/ML research with defensible claims — framework and rigor, data understood before claims, method decision records, claims traced to evidence, sources verified, and the write-ups that report them. An experiment or results write-up, even a README, is here, not project-documentation. Production serving → ml-model-deployment.

16 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use literature-review, context-engineering and 1 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.
  • JDerekLomasSkill

    literature-review

    Conduct comprehensive, systematic literature reviews using multiple academic databases (PubMed, arXiv, bioRxiv, Semantic Scholar, etc.). This skill should be used when conducting systematic literature reviews, meta-analyses, research synthesis, or comprehensive literature searches across biomedical, scientific, and technical domains. Creates professionally formatted markdown documents and PDFs with verified citations in multiple citation styles (APA, Nature, Vancouver, etc.).

    Also in 3 projects that use this

  • mrgoonieSkill

    context-engineering

    Master context engineering for AI agent systems. Use when designing agent architectures, debugging context failures, optimizing token usage, implementing memory systems, building multi-agent coordination, evaluating agent performance, or developing LLM-powered pipelines. Covers context fundamentals, degradation patterns, optimization techniques (compaction, masking, caching), compression strategies, memory architectures, multi-agent patterns, LLM-as-Judge evaluation, tool design, and project development.

    Also in 3 projects that use this

  • BlockSkill

    frontend-design

    Create distinctive, production-grade frontend interfaces with high design quality. Use this skill when the user asks to build web components, pages, or applications. Generates creative, polished code that avoids generic AI aesthetics.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

8 rules. 0 are common, 5 are distinctive, and 3 are very specific to this project.

  • 0

    Common

    Most of the 14 edited versions we read keep these.

  • 5

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Check the project's working agreement for a Methodology section.

    line 32
  2. Very specific:

    Write the choice into the working agreement's Methodology section (create the agreement via working-agreement if the project has none), …

    line 46
  3. Very specific:

    Invoke exploratory-data-analysis: before any result is interpreted, and plan it as the first item of the track, not an afterthought.

    line 63
  4. Distinctive:

    Every choice that shapes a result — algorithm, matching rule, threshold, metric, validation design — gets a method decision record …

    line 81
  5. Very specific:

    Before running: hypotheses, primary metric, operating point, decision rule, and which method decisions it rests on.

    line 95
  6. Distinctive:

    Write findings at the strength the evidence has:

    line 109
  7. Distinctive:

    Don't add qualifiers the output doesn't carry, such as a CI level or a test name.

    line 136
  8. Distinctive:

    Every source that carries a claim passes the identity rule in references/source-verification.md: it resolves to a DOI, arXiv ID, ISBN with …

    line 144

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

Research Methodology

Research differs from feature work in one way that changes everything: the output is a claim, and a claim is only as good as the trail behind it. The data was understood, the method was chosen for stated reasons, the experiment was defined before its result, the number traces to the code and data that produced it, and the sources say what they're cited for.

This skill does not impose a structure. The user picks the framework and how much rigour the work needs. What it holds fixed are the four rules below, because each one, skipped, has produced a claim that had to be withdrawn.

⛔ The Iron Law

No claim leaves the project — into a thesis, a report, a decision — without its trail: the data behind it understood, the method behind it decided on the record, the number traced to what produced it, the sources resolved.

A striking result is the one that most needs the trail. "We'll add it in the next revision" is how an unchecked claim survives into the final text.

Workflow

Step 1: Agree the Framework and the Rigor

Check the project's working agreement for a Methodology section. If there is none, offer options with a recommendation — don't impose one:

  • CRISP-DM (the default recommendation): business understanding → data understanding → data preparation → modeling → evaluation → deployment, iterated. Its data-understanding phase before modeling is the step research most often skips.
  • TDSP (Microsoft's Team Data Science Process): similar loop, adds roles and standard documents; fits a team with a client.
  • The user's own, written down in a few lines.

And the rigour level: thesis or publication grade (every claim registered, sources resolved to their identity), or internal and exploratory (claims marked provisional, lighter citation). The user sets it; record it.

Write the choice into the working agreement's Methodology section (create the agreement via working-agreement if the project has none), along with where experiments, method decisions and claims live — see templates/traceability.md.

This step is not a gate on delivering. Plan under the recommended framework and state it — "Planned under CRISP-DM at <rigour>; say if you'd rather use another" — then carry the plan in the same response.

When the request is production work on a model that's already built — serving it behind an API, monitoring drift, rolling it out — it belongs to ml-model-deployment: hand it over and help with the deployment itself. Leave this skill's research artefacts out of that answer (no framework choice, rigour level, method decision record or claims register); they are for work that is still producing claims.

Step 2: Understand the Data Before Any Claim

Invoke exploratory-data-analysis before any result is interpreted, and plan it as the first item of the track, not an afterthought. Running a benchmark early to smoke-test the pipeline is fine; reading meaning into its numbers before this step is not. For research it must cover:

  • Which source is authoritative — the curated table, not the raw one it was built from. Read how it is produced (code-archaeology for the pipeline).
  • How reliable each field is — validated measurement, or informational (an estimate, a free-text note, a field only some forms collected).
  • The distribution of every variable a claim will be split by. A gap between two groups means little if one group has 30 members.
  • What the reference data covers and doesn't. A survey that lists some households in some places makes every detection elsewhere look like a false positive: precision against it is a lower bound for the surveyed area, not a property of the method.

Step 3: Decide Methods on the Record

Every choice that shapes a result — algorithm, matching rule, threshold, metric, validation design — gets a method decision record (templates/method-decision-record.md): the candidates, the evidence for each, the criteria, the decision, and the alternatives worth trying later. "DBSCAN is standard" is a reason to list it, not to choose it.

Include instrument validity: was the tool, model or product built and evaluated for the variable you're about to report on? A building detector says nothing reliable about roof material unless someone measured that. If it wasn't, a result about that variable describes the instrument, not the world.

Step 4: Define Each Experiment Before Its Result

Before running: hypotheses, primary metric, operating point, decision rule, and which method decisions it rests on. Log and compare runs per ml-experiment-tracking; choose tests, intervals and multiple-comparison handling per statistical-analysis. A change after results exist is an amendment: label it as one, with the reason.

Step 5: Trace Every Claim

Each number that may be quoted goes in a claims register (templates/claims-register.md): the claim in words, its scope (area, population, product, period), the experiment, the commit and data version that produced it, and its status — provisional, supported or withdrawn.

Write findings at the strength the evidence has:

  • Measured — "recall was 0.41 (n = …, 95% CI …) for straw-and-mud roofs against 0.78 for chapa, in the surveyed area": state it.
  • Explained or generalized — "the product under-detects traditional roofs": only after Step 2's distributions, Step 3's instrument check and the confounders are done. Until then it is a provisional observation, worded as one.

Write each artifact for a reader who wasn't in the session. An experiment README, a results section or a method record is read later by the project owner, with nothing else open, and must make the work clear without the notebook or the code:

  • Open with what was found, in plain words, and what it changes. Provenance (commit, data version) follows the summary; it doesn't lead.
  • Say what was run, in a few lines: what it modelled or predicted, on which data, the method and its settings (algorithm, hyperparameters, thresholds), and why that method, with a link to its method decision record. Metrics without the run behind them can't be read. If the material doesn't say, ask; don't leave it out.
  • Keep each question, its result and what it means for the project together, in the same row or paragraph, not a table followed by a separate list of implications.
  • Link shared vocabulary; spell out the rest. Glossary terms, the methodology and other project-wide definitions have one home: link to it rather than restating it. Shorthand with no home (a notebook symbol, a step code, a decision named by date) is written out, or asked about.
  • Revising a dense document adds what the work is missing. Replacing a repeated definition with a link is fine; cutting what was done or what it means is not. Pre-registered text stays verbatim.
  • Don't add qualifiers the output doesn't carry, such as a CI level or a test name.

Under deadline, write the supported part now and mark the rest provisional. The minimal check a striking subgroup claim needs (group counts, per-group metric with intervals, one confounder cross-tab) is usually an hour, not a revision.

Step 6: Verify Sources

Every source that carries a claim passes the identity rule in references/source-verification.md: it resolves to a DOI, arXiv ID, ISBN with chapter, standard, or versioned page, and the quoted text is in a captured copy, not a search summary. Run this as an audit over any deep-research report before its citations are reused. Scale it to the rigour set in Step 1, and apply the same test to tools: a library or product the method depends on must be maintained and widely used, checked per dependency-management.

Rationalizations to Reject

ExcuseReality
"The result is striking; the EDA can come later"Striking subgroup results are the likeliest to be small-n noise or skewed labels. The check is small; the retraction isn't.
"We'll add the data description in the next revision"The claim gets written now and survives into the final text. Write it at the strength the data supports today.
"DBSCAN / U-Net / X is the standard method"Standard is a reason to list it as a candidate. Record what else was considered and why it lost.
"The product is state of the art"For what task? A detector evaluated on building presence hasn't been evaluated on roof material.
"Low precision means the method is poor"Against an incomplete reference, unmatched detections include real objects nobody surveyed. Bound it to the surveyed area.
"The deep-research report already has citations"Its citations are claims about sources. Resolve each one before reusing it.
"We need the 1977 original for every citation"Not for established results: a trusted later work that states them is enough. Chase the original when the claim is contested or load-bearing.

Red Flags — Stop and Check

  • A results section exists and no EDA of the labels does.
  • A method appears in code with no record of why it was chosen.
  • A claim is stratified by a variable whose group sizes nobody has looked at.
  • An experiment's decision rule was written after its result.
  • A number in the draft can't be traced to a commit and data version.
  • A citation points at a blog, a summary page, or a search snippet.

Cross-Skill References

  • exploratory-data-analysis — invoke it in Step 2, before the first result is interpreted. This skill still decides which claims wait on it; EDA does the profiling.
  • statistical-analysis — tests, intervals, power and multiple comparisons for each experiment.
  • ml-experiment-tracking — logging, comparing and reproducing runs.
  • working-agreement — holds the Methodology section and the rest of how the project runs (where status lives, session routines).
  • plan-execution — works through the research plan checkpoint by checkpoint.
  • code-archaeology — traces how a curated dataset is produced from raw inputs.
  • notebook-to-production and ml-pipeline-design — when exploratory code becomes a pipeline others rely on.
  • Out of scope: serving a model in production → ml-model-deployment.

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.