Docs-as-Code wird zu Docs-im-Code

Presentation
Software Documentation

10. November
10:05 - 10:50 AM (CET)
Plenum 1

finished

Marion Knebel
- parson AG
Ann-Cathrin Mackenthun
- parson AG

Doc-as-Code meint oft, dass die Dokumentation wie Quellcode in einem Versionskontrollsystem verwaltet wird und ähnliche Prozesse durchläuft wie der Code. Inhaltlich bleiben beide getrennt. Wir gehen einen Schritt weiter und schreiben die Dokumentation direkt im Code. Anhand einer Datenformatspezifikation zeigen wir, wie wir zusätzlich zu Code-Kommentaren Konzepte, Beispiele und Verarbeitungsregeln in Markdown-Syntax direkt im Code erstellen.

Takeaways

Wie lässt sich Dokumentation direkt in den Quellcode integrieren. Was sind die Vor- und Nachteile einer Docs-im-Code-Lösung, u.a. im Vergleich mit XML-basierter Dokumentation.

Speakers

Marion Knebel

parson AG

Show profile

Biography

Marion Knebel ist Technische Redakteurin, Consultant und Trainer für technische Dokumentation aus Berlin. Ihre Schwerpunkte sind das Schreiben von Spezifikationen, die Entwicklung von Informationsarchitekturen sowie die Beratung zu Redaktionsprozessen und Dokumentationslösungen. Gerne legt sie dabei selbst Hand an, was die technische Umsetzung angeht, z.B. von XML-Schemas.

Ann-Cathrin Mackenthun

parson AG

Show profile

Biography

Ann-Cathrin Mackenthun ist Technische Redakteurin für Softwaredokumentation bei der parson AG. Sie schreibt Dokumentation für Projekte aus der IT- und Automobilbranche und findet kundenspezifische Lösungen für Informationsarchitektur und Dokumentationsprozesse.

Back