Files
ai-workflow-course/modules/03-version-control-for-words/lab/adr-template.md
T
claude fbec36cb67 feat(course): build out all 27 modules, capstone, scaffold, and conventions
Scaffold the course repo and author the full curriculum in dependency-chain
order, following the settled build decisions in handoff.md.

- Scaffold: course README, vendor-neutral AGENTS.md (dogfoods Module 5),
  _TEMPLATE.md (the fixed 9-section module shape), root .gitignore, ship config.
- Modules 1-2: reference exemplars (locked for tone/depth/lab style).
- Modules 3-27: full lessons + runnable labs, each following the template,
  respecting the chain, vendor/model-agnostic, with "feel the pain" labs.
- Module 8 hosting comparison web-researched and date-stamped (as of 2026-06-22),
  not written from memory; expansion-zone modules carry Verify-before-publish.
- Capstone: the full loop end to end on the running tasks-app example.

Lab code syntax-checked (Python/shell/YAML); every module has the 7 core
template sections.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TfzV5QvtPDz8LJS3Pu5VLT
2026-06-22 12:18:30 -04:00

42 lines
1.5 KiB
Markdown

<!--
ADR template — Architecture Decision Record (lightweight).
An ADR captures ONE decision so the reasoning survives the meeting. Copy this file into your repo
(e.g. docs/adr/0001-some-decision.md), number it, and fill in the sections. Keep it short — an ADR
that nobody reads because it's long has failed at its only job.
In the Module 3 lab you hand this template to the AI and ask it to fill it out for a real decision,
then review its draft as a diff before merging. Write one sentence per line where you can: it keeps
future git diffs surgical instead of reflowing whole paragraphs.
Delete these HTML comments when you write the real ADR.
-->
# ADR NNNN — <short decision title>
- **Status:** proposed | accepted | superseded by ADR-XXXX
- **Date:** YYYY-MM-DD
- **Deciders:** <who made the call>
## Context
<!-- What's the situation that forces a decision? The problem, the constraints, what's at stake.
One short paragraph. State facts, not the conclusion. -->
## Decision
<!-- The choice, stated plainly in one or two sentences. "We will ___." -->
## Alternatives considered
<!-- The options you did NOT pick, and the one-line reason each lost. This is the part that saves a
future reader from re-litigating the decision. -->
- **<option>** — <why not>
- **<option>** — <why not>
## Consequences
<!-- What this decision makes easier, harder, or impossible later. Include the downsides you accepted
with open eyes — an ADR with no negative consequences is hiding something. -->