Document type: component
Table of Contents
This page defines the component 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 component.
Contract
- Folder
projects/<comp>/modeling/<comp>.org— always co-located with the component's code, so the doc updates alongside it.- Level
cross.- (no term)
- Not stateful — components are durable. No TODO. Audit may attach a
:stale:tag if the doc has drifted from the code. - Size
- 50–100 lines. The component doc is the index into the
component, not a full reference. Deeper material (architecture,
internals, design decisions) lives in linked
knowledgedocuments alongside the code. - How to create
- see How do I create a component overview?
- Required sections
* Summary— three to five sentences: what the component does and why it exists.* Inputs— what the component consumes (data, dependencies, configuration).* Outputs— what it produces.* Entry points— key files, classes, scripts, or commands, with paths.* Dependencies— other components or libraries this one needs.* See also— id-links to recipes operating on the component and to deeper knowledge documents about it.