Skip to content

Update ADR template #22

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.

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
housa opened this issue Mar 18, 2025 · 0 comments
Open

Update ADR template #22

housa opened this issue Mar 18, 2025 · 0 comments

Comments

@housa
Copy link
Contributor

housa commented Mar 18, 2025

The vision is that the ADR's can be seen as "mini blog posts", meaning that they are small self contained recommendations, that also describe why looking at this makes sense, and the overall idea behind even looking at it. Again think about what would be in a blog post, to describe why this particular thing is worth looking at.

Update the template for ADR's, specifically the Context and Problem Statement section, to include something along the lines of the following questions:

Do i need it?
What are the criterias for choosing this?
What are our weights for making a choice?

Make sure it is clear what should be in this section, so anyone starting an ADR can get a feel for what is expected of them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant