Skip to content

Commit 0840a8d

Browse files
brabojclaude
andauthored
docs(playbook): record a decision's diagram in draw.io (#1942)
ADR-049 to 051 show draw.io diagrams from docs/diagrams; the playbook step still asked for inline ASCII. It now names the source location, the style, the legend and the export command. Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
1 parent 39f3bd9 commit 0840a8d

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

‎docs/PLAYBOOK.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,15 @@ ADRs live in `docs/decisions/`; ADR-010 records the frontmatter schema.
175175
numbered rules, with RFC 2119 keywords), **Alternatives
176176
considered**, **Consequences**, **Compatibility** and
177177
**Security** (each "None" when nothing applies). Non-trivial
178-
decisions SHOULD include an inline ASCII diagram in Design.
178+
decisions SHOULD include a diagram in Design: a draw.io source in
179+
`docs/diagrams/` beside the PNG the record shows, styled like the
180+
existing files there and ending in a legend. Export it at twice the
181+
size with a 10 px border, and give the image alt text that states
182+
what it shows:
183+
```bash
184+
draw.io -x -f png -s 2 -b 10 -o docs/diagrams/NAME.png \
185+
docs/diagrams/NAME.drawio
186+
```
179187
5. If this ADR supersedes an existing one: update the old ADR's
180188
frontmatter in the same PR — set its `status: Superseded`,
181189
refresh `date`, and add this ADR's id to its `superseded_by`

0 commit comments

Comments
 (0)