Capturing research into a wskill
§ 1Purpose
Turn the durable output of an investigation into research blocks other agents — and external pipelines like a planner's researcher — can reuse instead of re-investigating.
§ 2Prerequisites
- An existing wskill folder that checks clean (just wskill-check).
§ 3Flowchart
§ 4Steps
§ 4.11
§ 4.2Investigate and keep the evidence
Do the research (web, docs, source-diving) and keep every locator you actually used — URLs, paths, versions. The bar for a finding: exact names and versions, specific calls or commands, the gotcha that cost time. "Check the docs" is not a finding.
§ 4.32
§ 4.4Distill one finding per research block
// data/research/<id>.wcl (import it from data/research/main.wcl)
research <id> {
topic = "<Headline of the finding>"
question = "<What the investigation set out to answer.>"
summary = "<One-line finding — shown in the research index.>"
checked = "<YYYY-MM-DD>"
applies_to = "<subject/version it holds for, e.g. bevy 0.18>"
source_ids = [<source block ids>]
locators = ["<ad-hoc evidence URLs/paths>"]
body { p "The full findings — exact names, versions, calls, gotchas." }
}
One finding per block, dated with checked and scoped with applies_to. Project-specific conclusions stay in the project that researched them; only durable, topic-level findings belong in the wskill.
§ 4.53
§ 4.6Link the evidence
Register durable upstreams as source blocks and reference them via source_ids; one-off URLs go straight in locators. Fill related with the unit ids the finding touches.
§ 4.74
§ 4.8Fold what's settled into real units
If part of the finding is settled, reusable knowledge (a value, a behaviour, a runbook step), ALSO capture it as the proper unit kind via the decision guide — the research block keeps the dated evidence trail; the unit carries the knowledge.
§ 4.95
§ 4.10Check, render, verify the contract
$ just wskill-check && just render
$ ls out/skill/references/research_*.md out/skill/references/index_research.md
The rendered skill must contain references/research_<id>.md for the new finding, list it in references/index_research.md, and show it under SKILL.md's ## Research section — that fixed layout is what external consumers glob.
Verification
references/research_<id>.md exists in the rendered skill, index_research.md lists it, and SKILL.md's Research section links it with its checked date.