Wenn Entwickler die Superhelden der Softwareindustrie sind, dann ist der Mangel an Dokumentation unser Kryptonit.
Kelsey Hightower
Es ist vier Uhr morgens und Ihr Pager schlägt an. Der Service Ihres Unternehmens ist abgestürzt und die Kunden geraten in Panik. Sie durchsuchen eine halb vertraute Codebasis, auf der Suche nach der Ursache. Die Fehlermeldungen in den Unit-Tests sind frustrierend ungenau und das interne README besteht aus Überschriften, gefolgt von sich wiederholenden Ein-Wort-Absätzen: [TODO].
Oder vielleicht läuft Ihr Service großartig und wird immer besser. Mit zunehmender Anzahl von Kunden tauchen Fragen auf. So viele Fragen. E-Mails und Support-Tickets strömen herein, während Ihr Service skaliert, und Sie werden zunehmend von der Entwicklung und dem Support abgelenkt.
Die meisten von uns lernen die Bedeutung von Dokumentation auf die harte Tour, indem wir feststellen, dass sie fehlt, wenn wir sie am dringendsten brauchen.
Gut dokumentierte Projekte sparen Zeit sowohl für die Entwickler im Projekt als auch für die Benutzer der Software. Projekte ohne ausreichende Dokumentation leiden unter schlechter Entwicklerproduktivität, Skalierbarkeit des Projekts, Benutzerakzeptanz und Zugänglichkeit. Kurz gesagt: Schlechte Dokumentation tötet Projekte.
Wir haben herausgefunden, dass die Qualität der Dokumentation den Erfolg von Teams bei der Umsetzung technischer Praktiken vorhersagt. Diese Praktiken wiederum sagen Verbesserungen der technischen Fähigkeiten des Systems voraus, wie beispielsweise Beobachtbarkeit, kontinuierliches Testen und Bereitstellungsautomatisierung.
Google 2021 Accelerate State of DevOps Report
Docs for Developers entmystifiziert den Prozess des Erstellens von großartiger Entwicklerdokumentation, indem es ein Team von Softwareentwicklern begleitet, während sie daran arbeiten, ein neues Produkt auf den Markt zu bringen. Bei jedem Schritt des Weges lernen Sie anhand von Beispielen, Vorlagen und Prinzipien, wie Sie Dokumentation erstellen, messen und pflegen können.
Erfahren Sie, wie Sie Dokumentation erstellen, die Sie und Ihre Benutzer produktiver macht.
Dieses Buch macht mit Entwicklerdokumentation das, was The Phoenix Project für DevOps macht – es macht Ihre Ambitionen erreichbar.
Anne Gentle, Autorin von Docs Like Code
Comments