Document type: investigation
Table of Contents
This page defines the investigation document type — one entry in the
document types taxonomy. The general contract every document follows
(frontmatter, state, linking, tags) lives on the taxonomy page; this
page carries only what is specific to investigation.
Contract
- Folder
doc/investigations/— historical records of technical investigations.- Title
Investigation: <human readable title>. TheInvestigation: = prefix is added by the codegen automatically when the type is =investigation.- Level
cross.- (no term)
- Not stateful — no TODO, no
* Statustable. An investigation report is a point-in-time record. - How to create
- see New investigation report in the codegen recipe.
- Required sections
* Context— one or two paragraphs: what was the original problem or research question.* Methodology— how the investigation was conducted (tools, reproducibility steps).* Paths taken— detailed log of approaches tried, including those that were unsuccessful. Link to related PRs, branches, or commits.* Conclusions— the ultimate findings of the investigation.* Recommendations— suggested next steps or new approaches, avoiding implementation-level detail.* See also— related knowledge docs, tasks, or external references.