Prompt file imported from achimdehnert/platform (
.windsurf/workflows/adr-review.md). Copyright stays with the author.
ADR Review Workflow
Trigger
User says: /adr-review ADR-[NNN] or "Review ADR-[NNN]" or "Reviewe ADR-[NNN]"
Step 1: Load the ADR
Read the ADR file from docs/adr/ADR-[NNN]-*.md in the platform repo (or the relevant service repo).
Also load the review checklist:
platform/docs/templates/adr-review-checklist.md
Step 2: Run through all 8 checklist categories
Work through each category systematically:
- MADR 4.0 Compliance — frontmatter (incl.
implementation_statusper ADR-138), title, sections, Confirmation - Platform Infrastructure Specifics — server IP, SSH, registry, ports, Nginx
- CI/CD & Docker Conventions — Dockerfile location, compose, health checks (NOT in Dockerfile!), pipeline
- Database & Migration Safety — Expand-Contract, tenant_id, shared DB risk
- Security & Secrets — no hardcoded secrets, SOPS, org-level secrets
- Architectural Consistency — service layer, no ADR contradictions, Guardian compatibility
- Open Questions & Deferred Decisions — all open questions addressed
- Modern Platform Patterns — infra-deploy, Multi-Tenancy, Content Store, catalog-info.yaml, Drift-Detector, Runner labels, Temporal (nur wenn relevant)
- ADR-138 Implementation Tracking —
implementation_statusin frontmatter (required for Accepted ADRs),implementation_evidenceif status is partial/implemented/verified, INDEX.md Impl column matches frontmatter - Glossar & Lesbarkeit — Glossar-Abschnitt vorhanden? Alle Abkürzungen/Fachbegriffe erklärt? Alphabetisch sortiert? Erläuterungen kontextbezogen (nicht nur Übersetzung)? Zielgruppe: Fachpersonal ohne IT-Hintergrund.
For each check: mark ✅ Pass, ⚠️ Minor issue, or ❌ Fail with a brief note.
Step 3: Output the review report
## 🔍 ADR Review: ADR-[NNN] — [Title]
### 1. MADR 4.0 Compliance
✅ 1.1 YAML frontmatter present
✅ 1.2 Title is a decision statement
⚠️ 1.5 Only 2 options considered — recommend adding ≥ 1 more
...
### 2. Platform Infrastructure Specifics
✅ 2.1 Server IP correct
❌ 2.3 StrictHostKeyChecking=no found in deploy-service.yml line 42 — replace with ssh-keyscan
...
[Continue for all 8 categories]
---
### 📊 Scoring
| Category | Score | Notes |
|----------|-------|-------|
| MADR 4.0 compliance | 4/5 | Missing Confirmation subsection |
| Platform Infrastructure Specifics | 5/5 | |
| CI/CD & Docker Conventions | 5/5 | |
| Database & Migration Safety | 5/5 | |
| Security & Secrets | 3/5 | StrictHostKeyChecking=no must be fixed |
| Architectural Consistency | 5/5 | |
| Open Questions | 4/5 | |
| Modern Platform Patterns | 5/5 | n/a for this ADR |
| **Overall** | **4.5/5** | |
---
### ✅ Stärken
- [List positives]
### ⚠️ Verbesserungsvorschläge
- [List minor improvements]
### ❌ Kritische Punkte
- [List blockers — must fix before Accept]
---
### 🎯 Empfehlung
[Accept / Accept with changes / Reject]
Soll ich die Änderungen direkt anwenden? [Ja/Nein]
Step 3.5: ADR-138 Compliance Quick-Check
Automatically verify:
- Frontmatter field: Does the ADR have
implementation_statusin its YAML frontmatter?- If missing and status is
Accepted: ❌ BLOCK — addimplementation_status: none(or appropriate value) - If missing and status is
Proposed: ⚠️ SUGGEST — addimplementation_status: none - If missing and status is
Deprecated/Superseded/Archived: skip (not applicable)
- If missing and status is
- Evidence field: If
implementation_statusispartial,implemented, orverified, doesimplementation_evidenceexist with at least one entry? - INDEX.md sync: Does the Impl column in INDEX.md match the frontmatter value?
none→ ⬜,partial→ 🔶,implemented→ ✅,verified→ ✅✅
Step 4: Apply fixes (if user confirms)
If user says "Ja" or "apply" or "fix it":
- Apply all ❌ critical fixes directly to the ADR file
- Apply ⚠️ minor improvements if user confirms
- Update ADR frontmatter:
amended: [today's date] - If review outcome is Accept: update
platform/docs/adr/INDEX.md— StatusProposed→Accepted - If
implementation_statuswas missing: add it to frontmatter and update INDEX.md Impl column - Push to GitHub with commit message:
fix(ADR-[NNN]): address review findings — [summary of changes]
Step 5: Update migration tracking (if applicable)
If the ADR has a migration tracking table (§4 or §5 pattern from ADR-021):
- Check if any items can be marked as done based on current repo state
- Suggest updates to the tracking table
Reference
- Checklist:
platform/docs/templates/adr-review-checklist.md(v2.0) - ADR Index:
platform/docs/adr/INDEX.md - MADR 4.0: https://adr.github.io/madr/
- Modern Platform Patterns: ADR-059, ADR-062, ADR-072, ADR-075, ADR-077
- Implementation Tracking: ADR-138 (lifecycle: none → partial → implemented → verified)
