Dieser Spicker erklärt die Idee von Documentation-as-Code detailliert und hilft euch beim Dokumentieren eurer Vorhaben.
Falk Sippach
Herausforderungen
- Die bestehende Dokumentation ist sperrig und veraltet. Wie könnt ihr sie mit euren gewohnten Tools erstellen und aktuell halten?
- Ein Bild sagt mehr als 1000 Worte. Mit welchen einfachen Ansätzen und Werkzeugen fertigt ihr Diagramme an?
- Bei Docs-as-Code gibt es viele Tools, Formate und Best Practices. Wie wählt ihr die für euer Umfeld richtigen aus?
- Implementierung und Dokumentation laufen mit der Zeit auseinander. Wie hält das Entwicklungsteam sie synchron?
In dieser Ausgabe
- Dokumentieren wird Implementierungssache
- Mit Textformaten die mentale Last verringern
- Aussagekräftige Diagramme schlank erstellen
- Dokumentation kontinuierlich am Leben halten
