Answer one question with sourced findings inside a time box: state the question, search the repo before the web, record each source with what it settles, and end with findings, open points and a recommendation. Use it whenever a decision or a capability needs facts first.
Instal·la
npx skillscat add osdlc/osdlc/research Instal·la des del registre de SkillsCat.
$craft:research
Usage:
$craft:research <question>researches one question with a default time box of one session.$craft:research <question> --sources repostays inside the repo.
Scope: one question, answered with cited findings. Not in scope: deciding (that is$craft:decision-make), or building anything.
Inputs: the question in one sentence, and the time box. Output: a research note with the
question, the sources, the findings, the open points, and one recommendation.
Steps
- Rewrite the question until it has one answerable subject. Write down what would count as
answered. - Search the repo first: decisions, standards, references, notes, and code. Record each hit as
a source with one line on what it settles or rules out. - Search outside only for what the repo could not answer. Prefer primary sources: specs,
source code, official docs. Record the URL and the date read. - Write the findings as short statements, each pointing at its source. Mark a finding
verified when you read or ran it, inferred when you did not. - List what stays open and what it would take to close it.
- Give one recommendation in two sentences, and stop when the time box ends even if points
stay open.
Grading
- The question is one sentence and says what counts as answered.
- Every finding points at a source, and every source says what it settled.
- Verified and inferred findings are marked apart.
- The note ends with open points and exactly one recommendation.
- The time box was kept.
Test environment
A scratch repo with two decisions that disagree on a point. Ask the question that exposes the
disagreement, with a short time box, and check that both decisions appear as sources and the
open point names the disagreement.