Documentation of the platform design

To keep track of architectural decisions, functional and technical design, a separate docs site (Internal only) is made available.

Architectural design records

Building a platform requires architectural decisions to be made continuously. Tracking this in issues / epics creates the danger of loosing track of what is current and actual. Architectural decision records provide an easy way to document decisions and link newer decisions to previous ones. Since architectural decisions are directly linked to the technical and functional design, these decision records are kept in the same place as the system documentation.

Use case diagram

When building a new platform from scratch, many new features and functions need to be created and designed. To keep an overview of all the functions, systems and subsystems, a use-case diagram seemed the best approach to document this. Another way of making design decisions is to use issues or epics to create new designs and decide on what to build. The disadvantage is that this is isolated to the context of the issue. You miss the broader overview and interactions with other parts of the system. Even though Balean is using an agile approach, using use-cases enables us to keep overview and make holistic desicions on the design of the platform.