Code-Dokumentation

• Warum ist Code-Dokumentation wichtig?
• Zielpublikum der Dokumentation:
  • Entwickler:innen
  • Personen, die die Software betreiben
  • Externe Entwickler:innen
  • Anwender:innen
• Dokumentationsartefakte:
  • Feindesign
  • Entwicklerhandbuch
  • Betriebshandbuch
  • Schnittstellendokumentation
  • Benutzerhandbuch
• Best Practices für die Dokumentation des Feindesigns:
  • Grundsätzliche Zusammenhänge und Interaktionen dokumentieren
  • Komplexe Abläufe und getroffene Entscheidungen beschreiben
  • Verworfene Alternativen und Begründungen auflisten
  • Code-nahe Dokumentation im Code selbst pflegen
  • DRY-Prinzip beachten
• Docs-as-Code:
  • Zentrale Pflege der Dokumentation (z.B. in einem Wiki)
  • Verwendung von Markdown oder AsciiDoc
  • Automatische Generierung der Dokumentation aus dem Code (z.B. mit Swagger)
• Kontinuierliche Dokumentation:
  • Richtlinien für die Dokumentation zu Beginn des Projekts festlegen
  • Dokumentation in die Definition of Done aufnehmen
  • Entscheidungen und Alternativen während der Entwicklung dokumentieren
  • Automatisierung der Dokumentationsgenerierung nutzen