Skip to content

Arch Forum 2023-04-06

Participants: Johan, Liangxiong, Thani, Victor and Zakarya

Agenda

  • Arch decision log
  • Documentation

Notes

The overall theme of this meeting was documentation.

Architecture decision log: In order to keep track of what is decided around technical architecture it is very useful to have a written down record of the actual decisions and context around it. It will also help us create a better architecture just by forcing a thoughtful process.

To start with, I have added the 3 main decisions from the last couple of weeks, see https://dev.azure.com/MAJORITY/Documentation/_wiki/wikis/Main/178/Decision-Log

General documentation: Zakarya brought up the general topic of documentation and a long discussion followed.
More questions than answers, and the discussion was more of aligning on what the issue is, why and what is needed than actual concrete results. Some of the discussion points:
- Minimum Viable Documentation is a good mindset
- Where to store documentation? Docs put directly in code repos have both advantages and disadvantages. Confluence (like rebtel) is not a good choice because of cost. JD likes to write things in Drive, but it easily becomes unstructured and not easy to find information there. The Documentation wiki we already use for many things (https://dev.azure.com/MAJORITY/Documentation/_wiki) is a good place.
- Diagrams are nice, i.e. the CDE diagrams that we must maintain. However, its also difficult to keep them up to date, and diagrams over everything probably becomes too messy to be useful.
- How can we be sure to not waste time on documentation no-one uses? Stale documentation might do more harm than good and we are all busy creating features.
- Platform has very little documentation, but might be the area that needs it the most. What to do?

Automapper vs source generation There exists an old ticket about investigation into Automapper replacement. We could directly conclude that this is lower priority than many other things since its mostly about performance and that we do not have huge performance issue around automapper: https://majority.atlassian.net/browse/MIB-6853