A community for discussion amongst professional software developers.
Posts should be relevant to those well into their careers.
For those looking to break into the industry, are hustling for their first job, or have just started their career and are looking for advice, check out:
I like them a lot. Sometimes I use it as an agenda to sell an idea in a meeting. Othertimes I backport them after a decision has been made. It’s the context that drives a decision that easily gets lost to time.
I’ve been burned when a technical decision hurt us down the road and no one could really remember why we made it to begin with.
We use them at my company. I love how new engineers can't just come into our codebase and start doing huge refactors. ADRs kind of force them to explain their rationale. We also use them to upvote on whether an architectural change should be implemented or not.
That sounds like you have slightly deviated from the simple ADR format (maybe not)? How do you perform the voting?
We just thumbs up the PR for an ADR if we're in favor of it. Does that differ from the ADR format?
I see. I guess if it's accepted then you update the Status in the PR and merge it? There isn't a single ADR format; there are several ADR formats that are successfully being used by different teams. The format I had in mind was the one introduced by Nygard (linked article). In our case, we generally first discuss the topic and then write the accepted decision in an ADR. So, there isn't much room for discussion/voting afterwards.
But it's good to learn about other people using it in different ways (a learning opportunity for me). It's interesting that you mention ADRs stopping people from refactoring. Do you have any examples you could give?
we generally first discuss the topic and then write the accepted decision in an ADR. So, there isn’t much room for discussion/voting afterwards.
This makes sense. I guess it would cut down on the noise in the PR since, at the point of its creation, it's already been accepted. Our repos have so many other teams contributing to them that it's hard to rally everyone to build consensus on an ADR beforehand. I guess we could hold meetings, but having feedback in a PR allows us to go back and look at what discussions led to a decision later on.
How does your team build consensus before opening the PR? Is it through slack or some other chat tool? Or maybe a meeting?
We do that in a meeting. In some cases it may take several meetings before we can make a decision. But I think those are generally fruitful meetings (I don't see them as waste of time). PRs give people a chance to think about these on their own pace, but when it comes to decision making, I feel like meetings actually save time (provided that people are sufficiently informed).
It's also possible that our ADRs deal with higher level decisions and is therefore easier to establish some sort of a consensus. From your description (especially the "refactoring" bit) I thought maybe you are using ADRs at a level that is closer to code. I cannot really think of our ADRs stopping people from refactoring the code in any way :)
The meetings approach is interesting. I think we did those for RFCs but I remember they were very very long and unproductive. I think the company size matters when determining the right approach.
I haven't seen mentioned in the post but there is a template for this here: https://github.com/adr/madr/
Also those things are pretty much mandatory when you write surgical or healthcare devices. They have weird names like SDD (detailed design) or SDS (detailed specifications). There is some info about it here: https://en.wikipedia.org/wiki/Software_design_description
The post is what started the whole ADR wave in the industry (I think there was also a conference talk by him). https://adr.github.io/ has a list of resources (templates, articles, examples, tools, etc.).