Skip to content

Commit f104864

Browse files
committed
docs: mention ADRs
1 parent 4abff84 commit f104864

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,23 @@ Use cases:
77
> [!NOTE]
88
> These are a beforehand sketch of the ideal use cases. Not all are, nor will be, implemented.
99
10-
# Decisions
10+
# General decisions
1111

1212
- Many of the design choices, naming, not making extensive documentation on APIs (or public members, of any sort), have been taken with the idea that this is "pet project", and that my default and preferred way of working is collaboratively with practices like pair and ensemble programing. In this scenario, unless stated otherwise to avoid interruption of flow, discussions occur on the go and decisions are taken withing seconds (as well as code reviews). Also, knowledge silos are mostly mitigated in this way.
1313
- As the only person in the team is me, obviously neither pair nor ensemble programming has taken place.
1414
- As with many things, I would discuss with the team if they prefer another way of working.
1515

16-
# Docs
16+
## Docs
1717
The UML usage style in this project is _sketching_, as described by Marting Fowler e.g. _UML Distilled, Martin Fowler (2009)_. This basically means that it is used as a quick sketch to clarify ideas in broad strokes, and is neither intended to be kept up to date nor describe the project fully.
1818

1919
In a real-life scenario, I'd discuss with the team if they are conformable with this approach or if another is needed.
2020

21+
### Documenting architectural, design or almost any decision made
22+
23+
Regarding keeping track of pretty much any kind of decision that the team takes, I like to use the [Architectural Decision Records (ADRs), by Michael Nygard](https://www.cognitect.com/blog/2011/11/15/documenting-architecture-decisions). For example, why one technology is used in favor of others, the reason why the API does things in a certain way, or even a convention that the team has decided following.
24+
25+
Given the simplicity of this project and that I am the only contributor, I've decided not to use them.
26+
2127
# Backend
2228

2329
In ASP.NET Core, using EntityFramework ORM for handling the persistence.

0 commit comments

Comments
 (0)