Documentation is an important ingredient to success. On these pages, we share ideas and templates for creating documentation for projects as well as documentation for processes, workflows and tools.
Project specific documentation shall be included in the Git repository under the folder /Documentation. Subfolders can be used to distinguish between documentation types, e.g. auto-generated code documentation, code architecture, ULM diagrams etc.
For all types of diagrams, we use the free and for all platforms available tool daraw.io. It can be used directly from the Browser, or as a desktop app. Link to the most recent version: https://get.diagrams.net/.
Online tools that work in the cloud (e.g. Canva, MS365, …) shall be avoided because of security and confidentially issues.
Do not store confidential customer data in untrusted cloud services!