DocGen documentation

DocGen is an AltaML engine for shipping client document-generation solutions in weeks, not months. This tree is organized on the Diátaxis model — four kinds of documentation, each answering a different question. A small product layer sits above Diátaxis so readers can first understand what DocGen is, who it serves, and what it can do.

A document flows through the engine: gather → compute → synthesize → render → verify. Facts are gathered and computed deterministically (never through an LLM); synthesis assembles framing — judgment and positioning, never facts — through the LLM; render emits each section by its render_mode. Full vocabulary: reference/domain-model.md.

Start here

Need	Start with
Understand the product	product/overview.md
See users and use cases	product/users-and-use-cases.md
See capability coverage	product/capabilities.md
Check current documentation/product status	product/status.md
Drive DocGen over /v1	how-to/authoring-and-config-api.md

Diátaxis modes

Mode	Answers	Start here
🎓 Tutorials	"Teach me, hands-on."	getting-started.md — author your first template and generate a document
🔧 How-to guides	"How do I do task X?"	authoring-and-config-api.md — the guide to driving DocGen over /v1
📖 Reference	"What exactly is X?"	domain-model.md — the canonical vocabulary
💡 Explanation	"How & why does it work?"	architecture.md and rendering-and-prompts.md

• New to DocGen? Read the product overview, then the getting-started tutorial.
• Driving DocGen (human or agent)? Go straight to how-to/authoring-and-config-api.md — everything (create, configure, export, update, generate) is done over the /v1 API. No back doors.
• Integrating against /v1? See the interface reference reference/v1-api.md (base URL, auth, endpoints, progress SSE, error shapes) and the machine-readable reference/openapi-v1.json.

Project areas (not Diátaxis modes)

These are project records, not product documentation — kept in their own areas because they answer none of the four questions above:

Area	What
📦 releases/	Per-release PRDs + TDDs + stories (R1–R5) and the roadmap. History.
🧭 design/	Design records — specs, plans, audits.
🏢 solutions/	Per-client solution configs (Odyssey, TomorrowLaw, GOA, DealDesk, …).
🛠 runbooks/	Repeatable operational procedures and pointers to the task guides used in operations.
🖼 _diagrams/	Hand-authored SVG diagrams used across the docs.
✅ documentation-audit.md	What was audited and what remains caveated.
📏 documentation-standard.md	The documentation rules for this repo.

---

Why this structure? Diátaxis separates documentation by the reader's need: tutorials are learning-oriented, how-to guides are task-oriented, reference is information-oriented, explanation is understanding-oriented. Mixing them makes docs worse; separating them routes every reader — and every agent — straight to what they need.