Page 1 of 1

A few questions regarding the architecture documentation

PostPosted:Fri Oct 29, 2021 8:20 am
by ThomasMol
Hi everyone,
We are 2 students from the Utrecht University in the Netherlands and we are doing research on software architecture documentation in open-source projects. We constructed diagrams using the C4 Model (https://c4model.com/) of the software architecture of openKM based on the available documentation and existing diagrams (taken from https://www.openkm.com/en/architecture.html & https://www.openkm.com/).

We constructed 3 levels (1 to 3) of the C4 model, where level 1 is a system context diagram showing the bigger picture of the architecture. Level 2 zooms in on the openKM software system itself, this is the container diagram. Level 3 zooms further in, we chose to zoom in on the core application of openKM. We also provide a legend. More information about the C4 Model and its standards/meanings can be found on https://c4model.com/.

We would like to ask you, maintainers and contributors of this project, a few questions regarding the diagrams. Thanks in advance!
  1. Do our constructed diagrams represent the system architecture well?
  2. Are there any systems, containers, components or relationships missing?
  3. What elements might need to be changed or removed?
  4. Do these diagrams help you understand the software architecture of openKM?
If you have any question for us, feel free to ask them!
Any other comments are welcome as well.

Re: A few questions regarding the architecture documentation

PostPosted:Fri Nov 05, 2021 5:47 pm
by jllort
It is right in the case of CE. In the case of the professional edition, the main difference is the user interface works with API directly.

Maybe in the diagran there's missing the plugin architecture that allows extending of some CORE features:
* https://docs.openkm.com/kcenter/view/ok ... ugins.html
* https://docs.openkm.com/kcenter/view/ok ... ugins.html ( in case of professional edition, for example, can build your own REST API high level methods )

Most of the cases accomplish with the diagrams, maybe someones have something else but will be something so special because.