De-slop: remove every em-dash + banned words across all modules + capstone (#94)
Sync course wiki / sync-wiki (push) Successful in 4s
Sync course wiki / sync-wiki (push) Successful in 4s
Co-authored-by: claude <claude@jpaul.io> Co-committed-by: claude <claude@jpaul.io>
This commit was merged in pull request #94.
This commit is contained in:
@@ -1,8 +1,8 @@
|
||||
<!--
|
||||
ADR template — Architecture Decision Record (lightweight).
|
||||
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
|
||||
(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,
|
||||
@@ -12,7 +12,7 @@
|
||||
Delete these HTML comments when you write the real ADR.
|
||||
-->
|
||||
|
||||
# ADR NNNN — <short decision title>
|
||||
# ADR NNNN: <short decision title>
|
||||
|
||||
- **Status:** proposed | accepted | superseded by ADR-XXXX
|
||||
- **Date:** YYYY-MM-DD
|
||||
@@ -32,10 +32,10 @@
|
||||
<!-- 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>
|
||||
- **<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. -->
|
||||
with open eyes; an ADR with no negative consequences is hiding something. -->
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
<!--
|
||||
Runbook template — the step-by-step for one operational task.
|
||||
Runbook template: the step-by-step for one operational task.
|
||||
|
||||
A runbook is read under pressure, often by someone who is not the person who wrote it and not at
|
||||
their best (it's 3 a.m., something is on fire). Optimize for "follow it exactly, no thinking
|
||||
@@ -11,10 +11,10 @@
|
||||
Delete these HTML comments when you write the real runbook.
|
||||
-->
|
||||
|
||||
# Runbook — <task name>
|
||||
# Runbook: <task name>
|
||||
|
||||
- **Purpose:** <one sentence: what this runbook gets you out of>
|
||||
- **When to run:** <the trigger — the alert, the symptom, the request>
|
||||
- **When to run:** <the trigger, e.g. the alert, the symptom, or the request>
|
||||
- **Owner:** <team or role responsible>
|
||||
- **Last verified:** YYYY-MM-DD
|
||||
|
||||
|
||||
Reference in New Issue
Block a user