21 private links
-
Sprecher und Thema:
Alanna Burke von amazee.io diskutiert in einem YouTube-Video mit dem Titel "Creating a Culture of Documentation" die Bedeutung von Dokumentation und deren verschiedene Verwendungszwecke für Kunden, neue Mitarbeiter und Unternehmen. -
Vorteile guter Dokumentation:
Burke betont die Vorteile einer qualitativ hochwertigen Dokumentation, darunter Klarheit, einfaches Verständnis und Genauigkeit. -
Zielgruppenansprache:
Sie unterstreicht die Bedeutung der richtigen Ansprache der Zielgruppe, damit die Dokumentation für Endbenutzer, Administratoren oder Entwickler genau und nützlich ist.- Beispiele für effektive Dokumentation:
Burke nennt Beispiele für effektive Dokumentation, darunter gut gestaltete Kubernetes-Dokumentation, Twilios Hauptdokumentationsseite und ein Feedback-System für Code-Bereitstellung.
- Beispiele für effektive Dokumentation:
-
Häufige Probleme schlechter Dokumentation:
Sie diskutiert die häufigen Probleme, die zu schlechter Dokumentation führen, wie das Fehlen von Anweisungen, die Verwendung von Fachjargon und Metaphern, die für andere nicht verständlich sind, falsche Zielgruppenanpassung und Fragmentierung der Dokumentation. -
Konsequenzen schlechter Dokumentation:
Die genannten Konsequenzen umfassen geringe Zufriedenheit und Produktivität am Arbeitsplatz, mangelnde Klarheit und Fehler im Produkt. -
Lösungsansätze:
Wenn Dokumentation nicht funktioniert, schlägt Burke drastischere Maßnahmen vor, wie das Nichtakzeptieren von Merge-Anfragen ohne Aktualisierung der Dokumentation oder die Integration der Dokumentation in die offiziellen Aufgabenbeschreibungen der Teammitglieder. -
Verantwortung für Dokumentation:
Sie betont, dass die Erstellung von Dokumentation die Verantwortung aller ist, beginnend mit ihrer Aufgabenbeschreibung, um sicherzustellen, dass die Leute den Wert des Produkts verstehen und sich verpflichten, die Dokumentation aktuell zu halten und zu schreiben, um sicherzustellen, dass sie es ordnungsgemäß verstehen. -
Handlungsaufruf:
Burke ermutigt die Zuhörer dazu, aktiv zu werden, und bietet Ressourcen wie eine Sketch-Präsentation sowie Videos und Folien aus ihren früheren Vorträgen zu diesem Thema an.