Skip to content

Commit

Permalink
Add daily email for 2024-06-12
Browse files Browse the repository at this point in the history
Recording architectural decisions
  • Loading branch information
opdavies committed Jun 17, 2024
1 parent eb35946 commit 1553fa8
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions source/_daily_emails/2024-06-12.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: Recording architectural decisions
date: 2024-06-12
permalink: daily/2024/06/12/recording-architectural-decisions
tags:
- software-development
cta: ~
snippet: |
Do you record architectural and technological decisions made on your projects?
---

I recently [saw this post on X][0], talking about an open-source project.

This was the part that I want to highlight:

> I was also impressed by the decisions documents. More projects should implement this concept.
Looking at the repository, it contains records of 36 decisions made on the project between May 2023 and April 2024.

Decision records provide useful information to new people to a project, whether you want to contribute to an open-source project or it's a new client or work codebase.

The code and project will likely continue once you've finished working on it, so capturing decisions for future Developers is key.

I've often joined projects and wondered why or how something was done, and can only guess as the decision wasn't recorded or is somewhere not available to me, such as an old wiki or ticketing system.

## Here's the thing

I agree with the poster.

More people should record the decisions made on their project, whether it's open-source or not.

[0]: https://x.com/StefanGalescu/status/1798421063355007017

0 comments on commit 1553fa8

Please sign in to comment.