Online-Dokumentation, die hilft: Strukturen, Prozesse, Tools

Mal eben etwas in der Online-Dokumentation für Nutzer ergänzen und schon ist es live? Und das so geschrieben und strukturiert, dass Nutzer wirklich davon profitieren?

Der Vortrag zeigt, welche Strukturen Nutzern helfen, wie Vorlagen das Schreiben der Dokumentation vereinfachen und wie das Ergebnis automatisiert geprüft werden kann. So entsteht schrittweise die notwendige Dokumentation, die neuen und bestehenden Nutzern beim Einstieg und in der täglichen Arbeit hilft. Je nach Zielgruppe können für Architekten, Entwickler, Admins und Endanwender verschiedene Sichten erstellt werden.

Als Werkzeuge kommen AsciiDoc, Antora und weitere aus dem Docs-as-Code-Ökosystem zum Einsatz. Als Beispiel dienen verschiedene Open-Source-Projekte, und es werden öffentlich verfügbare Online-Ressourcen zum Thema vorgestellt.

Lernziele

• Verständnis dafür, wie Nutzer Dokumentation nutzen
  
• Best-Practices für den Aufbau von Dokumentation
  
• Einstieg in das Ökosystem Docs-as-Code
  
• Grundlagen der Werkzeuge Antora und AsciiDoc