Files
ai-workflow-course/modules/03-version-control-for-words/lab/adr-template.md
T
claude 389ac2e460 style(no-slop): remove every em-dash + banned words across all modules + capstone
Apply the no-ai-slop standard (now binding in AGENTS.md): the em-dash character is
banned outright (restructured, not blind-replaced), plus the banned word/phrase
list (delve, leverage, robust, seamless, truly, unlock, etc.). 0 em-dashes remain
in modules + capstone; the only "robust" left is the planted M10 ai-change.patch
trap. Module H1 titles use a colon separator.

All deliberate teaching devices preserved; labs compile/parse (py/sh/yaml/json);
no junk. AGENTS.md updated with the hard no-slop rules.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TfzV5QvtPDz8LJS3Pu5VLT
2026-06-22 23:21:09 -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. -->