Architectural overview

The architectural overview will be provided using the C4 model to break down the design into multiple layers:

System context diagram

This will provide a very simplified view of the EveryBeam library, its users and the systems it interacts with.

Container diagram

The container diagram maps out the parts of a software system that are run independently or use differing technologies.

Component diagram

A component is a grouping of related functionality in the code base. The focus of this diagram is between the relations of those components.

Code diagrams

These diagrams will focus on one component only and uses UML to specify the relations between the classes in that component.