Skip to content

Add DRF (Decision Reasoning Format) to Other ADR templates #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
carlosinfantes wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add DRF (Decision Reasoning Format) to Other ADR templates #117

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions _posts/2024-10-25-adr-templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,5 @@ Finally, you can find more explanations and examples on Medium: [Y-Statements -
Numerous other ADR formats exist, many of which are also featured in [@joelparkerhenderson's GitHub repository](https://github.com/joelparkerhenderson/architecture_decision_record).

The [template](http://www.iso-architecture.org/42010/templates/) for [ISO/IEC/IEEE 42010:2011](https://en.wikipedia.org/wiki/ISO/IEC_42010), the international standard for architecture descriptions of systems and software engineering, suggests nine information items for ADRs its Appendix A. It also identifies areas to consider when identifying key decisions.

Where the templates above are prose-first, the [Decision Reasoning Format (DRF)](https://github.com/reasoning-formats/reasoning-formats) is schema-first: decisions are YAML documents validated against a JSON Schema, with the reasoning broken into named fields (constraints, objectives, assumptions, tensions, and the synthesis that resolves them) rather than free text. That makes the trade-off analysis queryable and lets a CI job reject a record that is internally inconsistent. A companion Context Reasoning Format (CRF) models organizational context - policies, systems, facts - as a graph that decisions reference, so a record can be checked against the constraints in force when it was made.