Philip Durbin 🚀 (Oct 07 2024 at 18:45): Philip Durbin 🚀 (Oct 07 2024 at 18:45):Any opinions on Architecture Decision Records (ADRs)?
I see they were mentioned once here in Zulip but I'm only just catching up, having heard about them in Fundamentals of Software Architecture. The book mentions adr-tools and I find the ADR records for that tool itself pretty interesting (0002-implement-as-shell-scripts.md, 0008-use-iso-8601-format-for-dates.md, etc.).
Philip Durbin 🚀 (Oct 07 2024 at 18:46):ADRs were first described by Michael Nygard at https://cognitect.com/blog/2011/11/15/documenting-architecture-decisions
Oliver Bertuch (Oct 07 2024 at 19:10):We are using them for HERMES. Good stuff. Can recommend.
Oliver Bertuch (Oct 07 2024 at 19:10):There's lots of options to improve our Software Architecture. Writing down things as ADRs definitely is a good, low hanging fruit.
Philip Durbin 🚀 (Oct 07 2024 at 19:26):Are any of your ADRs open source?
Oliver Bertuch (Oct 07 2024 at 21:27):Of course! We even add them to our docs page. https://docs.software-metadata.pub/en/latest/adr/index.html
Oliver Bertuch (Oct 07 2024 at 21:28):I do admit we are not very good at updating them... :see_no_evil:
Philip Durbin 🚀 (Oct 07 2024 at 21:54):Very nice! Thanks!
Oliver Bertuch (Mar 04 2026 at 15:10):@Philip Durbin 🚀 potentially scary idea: once a design doc is finished, export to text and put it into the Git based docs. This way it cannot be lost, as Dataverse is archived in Software Heritage.
Philip Durbin 🚀 (Mar 04 2026 at 15:11):Hmm, we used to export design docs to https://github.com/IQSS/dataverse/tree/develop/doc/Architecture
Michael and I put effort into this one, for example: https://github.com/IQSS/dataverse/blob/v6.9/doc/Architecture/auth.md
Oliver Bertuch (Mar 04 2026 at 15:15):So you suggest we do ADRs? :wink: https://github.com/joelparkerhenderson/architecture-decision-record
Philip Durbin 🚀 (Mar 04 2026 at 15:15):Sure! I think I agreed last time you asked. :sweat_smile:
Oliver Bertuch (Mar 04 2026 at 15:16):I'll move this conversation to a distinct topic.
Notification Bot (Mar 04 2026 at 15:17):5 messages were moved here from #dev > datasetType (software, workflow, review, etc.) by Oliver Bertuch.
Oliver Bertuch (Mar 04 2026 at 15:17):Wow it's been a while since we last discussed... :see_no_evil:
Philip Durbin 🚀 (Mar 04 2026 at 15:25):I'm proud that I kicked off this thread! :smile:
Last updated: Apr 03 2026 at 06:08 UTC