ores.doc

Table of Contents

This page is the node for the ores.doc technical space in the codegen physical-space address graph. Its title is its MASD address; it gathers the facets generated for this technical space. Each facet is its own document, linked from the table below. Codegen traverses this graph (root → technical space → facet → archetype) to resolve which archetypes an entity generates.

Summary

Org-mode document scaffolds — the machinery behind compass add, split across four facets by document family (agile, knowledge, modeling, template). Unusually for this technical space the renderer escapes nothing (pystache.Renderer(escape=identity)), and outputs are org files whose own structure must round-trip the literate escaping.

Shared conventions

  • Every scaffold opens with the :PROPERTIES:/:ID: drawer and the #+title/#+description/#+type/#+level/#+filetags/#+created/#+updated frontmatter contract.
  • Stateful types render #+todo: vocabularies and a * Status table at the type's default state.
  • Composition types receive parent_id=/=parent_title for the glossary-linked blurb.

Facets

Facets in this technical space — each links to its own node doc. Generated; do not edit by hand.

Facet Archetypes Description
ores.doc.agile 5 Agile artefact scaffolds: task, story, sprint, version, test_scenario.
ores.doc.knowledge 11 Prose doc scaffolds: knowledge, recipe, manual, skill, memory, capture, runbook, component, investigation, product identity, release notes.
ores.doc.modeling 8 Entity-modeling doc scaffolds: entity_org, field_group, junction, lookup_entity, service_registry, dataset, profile, feature.
ores.doc.template 4 Codegen template scaffolds: facet, facet_group, technical_space, archetype docs.

See also

  • Parent: the ores physical-space root.

Emacs 29.3 (Org mode 9.6.15)