tekom - Tagungen

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

  • Fachvortrag
  • Software Documentation
  • 10. November
  • 10:05 - 10:50 AM (MEZ)
  • Plenum 1
  • beendet
  • Folien
  •  Marion Knebel

    Marion Knebel

    • parson AG
  •  Ann-Cathrin Mackenthun

    Ann-Cathrin Mackenthun

    • parson AG

Inhalt

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.

Das lernen Sie

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.

Referent:innen

 Marion Knebel

Marion Knebel

  • parson AG
Biografie

Marion Knebel ist Beraterin und Technische Redakteurin bei der parson AG. Ihre Schwerpunkte sind Informationsarchitekturen sowie das Schreiben von Spezifikationen für technische Standards aus verschiedenen Branchen. Bei Bedarf passt sie auch selbt gerne XML-Schemas und unterstützt die Kolleg:innen bei der Anpassung technischer Lösungen.

 Ann-Cathrin Mackenthun

Ann-Cathrin Mackenthun

  • parson AG
Biografie

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.