Welches Level ist dieser Kurs?

Dieses Seminar befindet sich auf Level 2 und richtet sich an Fortgeschrittene, die bereits Erfahrung in der Softwaredokumentation haben und nun lernen möchten, wie sie moderne Docs-as-Code-Praktiken anwenden, um ihre Dokumentation effizienter und skalierbarer zu gestalten.

Worum gehts?

In diesem Seminar geht es darum, wie du Softwaredokumentation nach dem Docs-as-Code-Ansatz erstellst und verwaltest. Du lernst, Dokumentation direkt im Code-Repository zu integrieren, um sie nahtlos mit der Entwicklung zu verzahnen. Der Fokus liegt auf Automatisierung, Versionskontrolle und dem Einsatz moderner Tools, um eine kontinuierliche Dokumentationsqualität sicherzustellen.

Welche Lektionen gibt es?

• Einführung in Docs-as-Code:
  • Was ist Docs-as-Code?
  • Warum ist es relevant in der modernen Softwaredokumentation?
  • Vorteile gegenüber traditionellen Dokumentationsmethoden
• Grundlagen und Prinzipien
  • Einsatz von Git für Dokumentationszwecke
  • Pull Requests, Branching und Merge-Strategien
  • Continuous Integration (CI) und Continious Deployment (CD) für Dokumentation
  • Automatisierte Tests und Builds für Dokumentation
• Tools und Technologien
  • Markdown, reStructuredText, AsciiDoc
  • Vergleich und Auswahl der geeigneten Sprache
  • Dokumentationsgeneratoren: Sphinx, MkDocs, Jekyll – Einsatz und Konfiguration der Tools
  • Versionskontrollsysteme: GitLab, GitHub, Bitbucket – Einrichtung und Verwaltung von Repositories
• Praktische Anwendung
  • Schritt-für-Schritt-Anleitung zur Erstellung einer Dokumentation von Grund auf
  • Aufbau einer Pipeline für automatisierte Builds und Deployments
  • Strukturierung und Organisation von Dokumentationsprojekten
  • Wartung und Pflege von Dokumentation

Für wen ist der Kurs geeignet?

Dieses Seminar ist ideal für Technische Redakteur:innen, Entwickler:innen und Dokumentationsspezialist:innen, die bereits Erfahrung mit Softwaredokumentation haben und moderne, effiziente Ansätze zur Dokumentationserstellung erlernen möchten. Es richtet sich an alle, die die Vorteile des Docs-as-Code-Ansatzes nutzen wollen, um ihre Dokumentationsprozesse enger mit der Softwareentwicklung zu verknüpfen und durch Automatisierung und Versionskontrolle zu optimieren.