Documentation facet

Table of Contents

Summary

The documentation facet is the literate-document projection of the model: the agile and knowledge docs, skills, recipes and runbooks that ores.codegen scaffolds under --profile doc. It is the largest facet by template count, because ORE Studio's working knowledge is itself a generated artefact — scaffolded with consistent frontmatter, IDs and structure, then filled in by hand.

Detail

Where the other facets project code from the model, the documentation facet projects the information architecture that surrounds it. The templates scaffold the standard doc types — story, task, sprint, recipe, knowledge, skill, runbook, capture, memory and the modeling docs — each with the required :ID:, #+title, #+type, #+filetags and section skeleton, so every document satisfies its type contract by construction.

These are scaffolds, not finished prose: the generator gives a contract-correct skeleton and a fresh UUID, and the author fills the body. As with every facet, read the template for the authoritative skeleton rather than reproducing it here.

See also

  • Facet — the MASD facet concept this instantiates.
  • Applied MASD — the full facet catalogue and codegen routes.
  • doc — the literate templates that generate this facet.

Emacs 29.1 (Org mode 9.6.6)