• A few questions regarding the architecture documentation

  • Help us to improve OpenKM! Be part of the Open Source Community.
Help us to improve OpenKM! Be part of the Open Source Community.
Forum rules: Please, before asking something see the documentation wiki or use the forum search function.
 #52965  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.
Attachments
C4ModelsOpenKM-Level1.drawio.png
C4ModelsOpenKM-Level1.drawio.png (80.16 KiB) Viewed 8068 times
C4ModelsOpenKM-Level2.drawio.png
C4ModelsOpenKM-Level2.drawio.png (160.83 KiB) Viewed 8068 times
C4ModelsOpenKM-Level3.drawio.png
C4ModelsOpenKM-Level3.drawio.png (247.41 KiB) Viewed 8068 times
C4ModelsOpenKM-Legend.drawio.png
C4ModelsOpenKM-Legend.drawio.png (83.66 KiB) Viewed 8068 times
 #52982  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.

About Us

OpenKM is part of the management software. A management software is a program that facilitates the accomplishment of administrative tasks. OpenKM is a document management system that allows you to manage business content and workflow in a more efficient way. Document managers guarantee data protection by establishing information security for business content.