The letter S in a light blue, stylized speech bubble followed by SpeakBits
SpeakBitsThe letter S in a light blue, stylized speech bubble followed by SpeakBits
Trending
Top
New
Controversial
Search
Groups

Enjoying SpeakBits?

Support the development of it by donating to Patreon or Ko-Fi.
About
Rules
Terms
Privacy
EULA
Cookies
Blog
Have feedback? We'd love to hear it!

How Senior Software Engineers Document Their Project

dev.to
submitted
7 mos ago
byjustadevtoprogramming

Summary

Small attention to detail is what separates a good engineer from a bad one. The ADR is a document that traces all changes made to an architecture.

An ADR is a document that explains a company’s decision to use a new database. It can be written by a developer, or a project repository, or even a notion, or JIRA. There are several conventions to follow, but you can always adapt them to what works best for you.

Using GitLab issues and linking every change to an issue branch helped us track the reasons behind changes, even months after implementation. This practice saved us countless times.

 web site website internet site site cash machine cash dispenser automated teller machine automatic teller machine automated teller automatic teller ATM microphone mike screen CRT screen-0
20

5 Comments

4
joesch
7 mos ago
I really like this one! I struggled with that forever until finding Amazon's ADR repo. Seeing this years ago would have gotten me there much quicker.
3
boredgamer
7 mos ago
I feel like every developer struggles with documentation. It truly is an art.
2
joesch
7 mos ago
One of the few truths in the world
2
justadevOP
7 mos ago
I hadn't seen this one! It's pretty intuitive with how I already work!
2
joseph
7 mos ago
Documentation is an art