Document-as-Code Lab

Source file

Tutorial design decisions — owner-approved direction for v1.2

19 October 2026. Use this file for the tutorial update and as a small decision-register pattern for future tutorial projects. Do not silently represent these design decisions as historical ADRs already in the source repository.

IDStatusDecisionRationale / boundaries
TD-01AgreedIntended tutorial has 11 chapters; Chapter 12 is removedAvoid redundant adoption chapter. Clean up dependent links and slide sources without restoring deleted chapter.
TD-02AgreedBrowser-first core; optional local exercisesConventional exercises are not required; reader can understand without installation or accounts.
TD-03AgreedShort chapters, detail in reference guidesEach chapter earns its place through a distinct insight; link deeper material by value.
TD-04AgreedScenario-based, in-context knowledge checks with immediate rationaleRealistic decisions near the teaching moment; no scoring, streaks, compulsory completion, or obvious comparisons.
TD-05AgreedPreserve existing labs/explorers when useful; guide entry to complex explorationAdd a meaningful first question, not a new graph application.
TD-06AgreedPurposeful modern visual elements based on existing site visual identityPreserve calm design; components must clarify a concept, state or navigation.
TD-07AgreedChapter 8 is about agent-ready project informationAGENTS.md entry point, architecture, terminology, rationale/decisions, authoritative sources, checks; avoid trivial context vs no-context benchmark.
TD-08AgreedDesign review by tutorial owner, then technical verificationNo mandatory external reader studies at this stage; avoid claiming broad learning effectiveness.
TD-09AgreedAll seven v1.2 improvements in one coordinated updateOne integration package/PR with internally reviewable workstreams and a verification report.
TD-10Conservative implementation defaultKeep existing Astro, GitHub Pages, Mermaid, YAML/Reveal.js, stable IDs and paletteOnly change tech when demonstrated necessary.
TD-11Owner reviewExact new visuals, scenario wording and whether a new project-knowledge map/ADR file is neededAgent provides a concrete candidate; owner accepts or revises. No invented historical decisions.
TD-12Owner reviewChapter 8 headline: Making Information Usable by AI AgentsWorking title; keep stable filename 08-ai-native.md and frontmatter ID 04-ai-native.
TD-13Agreed, 19 October 2026Apply the accepted v1.3 editorial style across eleven chaptersThe owner accepted the three samples. Lead with situations, keep explanations cohesive, reduce repetition, and preserve technical meaning. Full revised chapters remain in review.

Open design boundaries, not blockers

  • Use the existing site palette by default; show renderings for owner approval rather than pausing all work for a color decision.
  • Chapter 11 can remain mostly unchanged; remove obsolete ‘Next Ch 12’ and fix factual inconsistencies.
  • A lean source/architecture guide and decision log may be added if they reduce repeated instructions. Inspect and reuse AGENTS.md, CONTRIBUTING.md, GLOSSARY.md, README.md and existing reference files before creating anything.
  • Scenario checks are optional per chapter, not a new mandated count. Initially implement in Ch 5/6/8; others may be proposed later.