Analyse und Dokumentation von Messtechnik-Systemen – Architekturdokumentation nach arc42/req42 mit automatisierter Dokumentationserzeugung

Kenntnisse Interesse an technischer Dokumentation und Software-Architektur, Kenntnisse in Linux/Embedded-Systeme, C/C++,  Skripting, Markdown/AsciiDoc, XML, Git, KI Claude wünschenswert

Beschreibung

Die Delphin Messgeräte (z. B. ProfiMessage D, Expert Logger, Loggito) bestehen aus einem eingebetteten Betriebssystem, der Geräte-Firmware und der zugehörigen PC-Software. Die technische Dokumentation dieser Systeme ist historisch gewachsen und liegt in unterschiedlichen Formaten und Detailtiefen vor.

Ziel der Arbeit ist es, die bestehenden Systeme zu analysieren, die Architektur- und Anforderungsdokumentation nach den Vorlagen arc42 und req42 aufzubauen bzw. zu konsolidieren und die Erstellung dieser Dokumentation so weit wie möglich zu automatisieren (Docs-as-Code). Eine belastbare, aktuelle Dokumentation ist zugleich Voraussetzung für die Nachweisführung nach Cyber Resilience Act (EU 2024/2847) und IEC 62443.

Aufgaben

• Ist-Analyse der vorhandenen Dokumentation und Identifikation der Lücken
• Analyse von Betriebssystem, Firmware und Anwendungssoftware der Messgeräte (Schnittstellen, Dienste, Datenflüsse, Konfiguration)
• Nutzung / Optimierung einer Architekturdokumentation nach arc42 sowie einer Anforderungsdokumentation nach req42
• Nutzung / Optimierung der Dokumentationsautomatisierung: Generierung aus Quellcode, Konfigurationsdateien und Schnittstellenbeschreibungen, Versionierung in Git, Einbindung in die Jenkins-Build-Pipeline (DevOps/CI-CD), Export nach HTML/PDF
• Bewertung von Werkzeugketten (z. B. AsciiDoc, Doxygen, Jenkins)
• Dokumentation der Ergebnisse und Handlungsempfehlung für den Regelbetrieb

Was wir bieten

• Betreuung durch erfahrene Entwickler und direkte Einbindung ins Team
• Reale Produkte und Systeme statt Laborbeispiele
• Flexible Arbeitszeiten, Möglichkeit zur Übernahme nach dem Abschluss