Português (Brasil) · Documentation home · Template selection
For executable architecture evidence, see the bilingual architectural-drift case study.
This library contains ADR document examples that show how to record decisions. For an automation example that shows those documents being validated in a real pull request, use the GitHub Actions demo.
These examples express the same decision—using PostgreSQL as the order system of record—at three levels of structure. They contain completed reasoning rather than template prompts. Each language and format lives in a separate directory because every sample intentionally uses ADR ID 0001 and format selection applies to the whole validated set.
| Example | Why this form fits |
|---|---|
| Minimal, English · Portuguese | The decision can be understood from context, decision, and balanced consequences. |
| Extended, English · Portuguese | Reviewers need explicit drivers, alternatives, rationale, risks, and ownership. |
| MADR 4.0, English · Portuguese | The team uses MADR's option and decision-outcome structure. Start with new --adr-format madr-4, then replace guidance and record human approval explicitly. |
The Portuguese examples keep invariant English structural headings so the matching validator can parse them. Their ADR filenames cannot use the normal .pt-BR.md documentation suffix because valid ADR filenames must match NNNN-lowercase-kebab-case.md; separate pt-BR directories provide localization without weakening that contract.
Build once, then run each isolated set with its declared mode:
dotnet build AdrGuard.slnx
dotnet run --project src/AdrGuard -- check docs/examples/canonical-minimal/en
dotnet run --project src/AdrGuard -- check docs/examples/canonical-minimal/pt-BR
dotnet run --project src/AdrGuard -- check docs/examples/canonical-extended/en
dotnet run --project src/AdrGuard -- check docs/examples/canonical-extended/pt-BR
dotnet run --project src/AdrGuard -- check docs/examples/madr-4/en --adr-format madr-4
dotnet run --project src/AdrGuard -- check docs/examples/madr-4/pt-BR --adr-format madr-4To preview the native minimal template without writing or reserving an ID:
dotnet run --project src/AdrGuard -- new docs/examples/madr-4/en --title "Evaluate a cache" --adr-format madr-4 --template minimal --previewPassing these checks confirms structure, filename, status, and references—not the technical merit or organizational approval of the example decision.