[Idea] Architecture Decision Record

[alrik-durand]

Should Qudi have a Architecture Decision Record (ARD) ?

An architectural decision record (ADR) is a document that captures an important architectural decision made along with its context and consequences.

Let me explain,
We are currently working on a new set of modules in our lab, and we were discussing on the architecture decisions for the interface. One example of such question is "what should a setter return ?". We tried to look at other interfaces for help, but they are quite heterogeneous.

Using an ARD could help with this problem, by creating a place where a joint decision is recorded and explained, in the context of the Qudi software.

Here is a link with more detail about what ARD are and how they can me implemented
https://github.com/joelparkerhenderson/architecture_decision_record

What do you think of the proposed idea ?

Alrik