Skip to content
Snippets Groups Projects
Commit 0f568285 authored by Michelle Weidling's avatar Michelle Weidling :blowfish: Committed by Mathias Goebel
Browse files

Apply 1 suggestion(s) to 1 file(s)

parent 0a8ec822
No related branches found
No related tags found
1 merge request!102feat: add recommendations on documentation
Pipeline #429812 passed
......@@ -2,7 +2,7 @@
Several aspects of documentation are related to the life-cycle of our products. As a very basic foundation, it is mandatory to have a kind of an in-place documentation, for example by appropriate verbose function documentation.
A good documentation SHOULD focus on several target groups (when applicable): developer, operator and user of the software.
A good documentation `SHOULD` focus on several target groups (when applicable): developer, operator and user of the software.
Also it is `RECOMMENDED` to create and update a general overview of the software architecture accompanied by at least one
graphical representation of the major components and their interaction.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment