I have to describe how the firmware works

• plantuml

  123 9,600 9.4 Java

  Generate diagrams from textual description

  

You can try to use the doxygen for the documentation and PlantUML for the UML, of course.

• sphinx

  31 6,032 9.8 Python

  The Sphinx documentation generator

  

I use Sphinx + Breathe + doxygen. Doxygen on its own works okay for documenting the "what" (i.e. function xyz does abc) but does not work well for documenting the "why" (e.g. architecture, functionality, usage). Sphinx is much better suited for long-form documentation and it looks a lot better. See the Zephyr docs for an example of this documentation toolchain.

• InfluxDB

  www.influxdata.com sponsored

  Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

  

• drawio-desktop

  125 46,687 8.6 JavaScript

  Official electron build of draw.io

  

I highly recommend using drawio/diagram.net (https://www.diagrams.net/), which supports a file format that embeds the "source" for the drawing inside of the .svg. There's a plugin for VS Code, or a desktop app, or a web tool.

Suggest a related project