23. September 2026 | Regionalgruppe München

Beirat Online-Events: Mit Sphinx-Needs komplexe Docs-as-Code-Projekte erfolgreich umsetzen

Event information | Registration

Wie sichert man die lückenlose Nachverfolgbarkeit von Informationen, wenn eine einzige technische Änderung dutzende Dokumente betrifft? Anforderungen, Spezifikationen, Testfälle, Produktmerkmale und Sicherheitshinweise müssen über den gesamten Produktlebenszyklus konsistent und nachvollziehbar bleiben – eine enorme Herausforderung bei komplexen Produkten und in regulierten Branchen.

Genau für diese Aufgabe wurde das Open-Source-Werkzeug Sphinx-Needs entwickelt. Experte und Code-Maintainer Daniel Woste gibt Ihnen hier einen exklusiven Einblick, wie Sie mit diesem Werkzeug strukturierte Informationseinheiten – sogenannte „Needs“ – direkt im Quelltext definieren und logisch miteinander verknüpfen.

In dieser Veranstaltung wird verständlich erklärt, wie Sie mit Sphinx-Needs:

• Merkmale, Anforderungen, Spezifikationen oder Testfälle als wiederverwendbare Objekte direkt im Text (Doku-Quellcode) erstellen,
• die Nachverfolgbarkeit zwischen diesen Objekten sicherstellen und komplexe Abhängigkeiten abbilden,
• externe Daten (z. B. aus Werkzeugen wie JIRA oder GitHub) nahtlos in Ihre Dokumentation integrieren,
• Architekturelemente über PlantUML dynamisch und konsistent visualisieren und
• die Grundlagen für eine normgerechte Dokumentation (z. B. nach ISO 26262) legen können.

Das Highlight: In einer praxisnahen Live-Demo erleben Sie, wie die Arbeit mit Needs-Objekten im Doku-Quellcode konkret aussieht.

Darüber hinaus regt die Veranstaltung dazu an, über den Tellerrand hinauszublicken und das Funktionsprinzip von Sphinx-Needs auch auf andere strukturierte Redaktionsinhalte, beispielsweise Glossare, zu übertragen. Diskutieren Sie mit, welche weiteren Möglichkeiten der Ansatz von Sphinx-Needs für die Technische Dokumentation bietet!

Diese Veranstaltung ist Teil der Online-Reihe "Docs as Code", initiiert vom Beirat Online-Events – zu Gast bei der Regionalgruppe München.