Document type: knowledge
Table of Contents
This page defines the knowledge 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 knowledge.
Contract
- Folder
- Cross-cutting knowledge (not specific to one component) lives at
doc/knowledge/{domain,architecture,...}/. - Component-specific knowledge (deeper analyses tied to one
component's code) lives co-located at
projects/<comp>/docs/.
- Cross-cutting knowledge (not specific to one component) lives at
- Level
cross- (no term)
- Not stateful — no TODO. Audit may flag stale facts via a tag.
- How to create
- see New knowledge document in the codegen recipe.
Index pages (knowledge / meta variant)
When a knowledge or meta document's role is navigation — it summarises a tree of related documents and links to them — it is called an index page. Examples in this repo: Compass, Agile, Product backlog, the next and deferred bucket indexes.
Index pages have three extra requirements on top of the usual knowledge / meta contract:
- Blurb before the first headline. One paragraph between the
frontmatter and the first
*heading. It tells the reader, in one look, what is being indexed and why. Without it, the page lands on a heading with no orientation. The blurb hyperlinks key terms (the things this page is indexing) to their glossary entries or to the downstream pages. - Internal links woven into content. Cross-references to other docs in this repo sit inline in the prose or in the bullet lists they pertain to — not in a separate "See also" dumping ground. Every section should link somewhere relevant when the topic demands it.
* See alsois for external references only. Blog essays, external standards, vendor docs — material that lives outsidedoc/. If the only thing you'd put in See also is an internal id-link, the link belongs in the body instead.
If all three rules hold, the page is acting as an index. If none do, it is a normal knowledge document — no extra obligations.
- Required sections
- Blurb — the 3-5 sentence overview, between the frontmatter and
the first
*heading. Knowledge docs do not carry a separate* Summarysection; the summary is the blurb. * Detail— the content.- See also — optional, for external cross-references only (internal references weave into the body).
- Blurb — the 3-5 sentence overview, between the frontmatter and
the first