Experienced Devs

3928 readers

1 users here now

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:

Logo base by Delapouite under CC BY 3.0 with modifications to add a gradient

founded 1 year ago

MODERATORS

[email protected]

Documenting Architecture Decisions (cognitect.com)

submitted 1 year ago* (last edited 1 year ago) by [email protected] to c/[email protected]

21 comments fedilink hide all child comments

I wonder if there are others using ADRs for documenting their decisions.

you are viewing a single comment's thread
view the rest of the comments

[–] [email protected] 2 points 1 year ago (1 children)

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

[–] [email protected] 2 points 1 year ago* (last edited 1 year ago)

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.).