SRE suchen

Kapitel 19. Do Docs Better: Integration der Dokumentation in den technischen Arbeitsablauf

Diese Arbeit wurde mithilfe von KI übersetzt. Wir freuen uns über dein Feedback und deine Kommentare: [e-mail]

Ríona MacNamara und Shylaja Nukala, mit Stas Miasnikoŭ, Aaron Gillies, Jeremy Sharpe, Google, und Niall Richard Murphy, Microsoft

In der gesamten Softwarebranche ist das Vertrauen in die technische Dokumentation gering. In der Entwicklerumfrage von Stack Overflow aus dem Jahr 2016 wurde die Dokumentation als zweitwichtigste Herausforderung für Entwickler genannt.

Das ist ein Problem. Fehlende, unvollständige, veraltete oder ungenaue Dokumentation beeinträchtigt die Entwicklungsgeschwindigkeit, die Softwarequalität und - für SREs besonders wichtig - die Zuverlässigkeit der Dienste. Und die Frustration, die dadurch entsteht, kann ein Hauptgrund für die Unzufriedenheit der Entwickler sein.

Dokumentation kostet Zeit und Mühe, und das ist für SREs eine besondere Herausforderung. SREs verbringen oft 35% ihrer Zeit mit operativen Aufgaben, so dass nur 65% für die Entwicklung übrig bleiben. Die Zeit, die für die Dokumentation aufgewendet wird, muss aus dem Entwicklungsbudget bestritten werden, und das ist eine Herausforderung, wenn die Erstellung und Pflege der Dokumentation als lästige Arbeit angesehen wird, die bei Leistungsbeurteilungen und Beförderungen nicht anerkannt oder belohnt wird.

Wie kann das geändert werden? Wie kannst du deiner Organisation den Wert ...