Good Practices

Living Documentation

Behavior Driven Development Ansatz => Anforderungen in Prosa-Text

Orthogonal

Beschreiben, was nicht unmittelbar aus dem Code ersichtlich ist

Auf Zielgruppe zugeschnitten

Wie z.B. Schnittstellen-Dokumentation

Tools

wie z.B. "Storybook.js"

"GitHub Copilot" zur Unterstützung des Schreibens

Automatische Prüfungen, wie Spell Checks

READMEs

Kick-off für neue Entwickler, mit der Arbeit starten zu können

Definition of Done (DoD)

Gemeinsames Verständnis schaffen für den Sinn hinter guter Dokumentation

=> Zusätzlich als Task immer dazu erstellen - z.B. eigenes Ticket im Issue-Board

=> Peer Review: Merge Request wir nur genehmigt inkl. Doku

So wenige Stellen wie möglich

Bestenfalls eine "Single Point of Truth" für technische Dokumentation

=> Konsistenz