Softwareentwicklung bei Google

Kapitel 10. Dokumentation

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

Geschrieben von Tom Manshreck

Herausgegeben von Riona MacNamara

Von den Beschwerden, die die meisten Ingenieure über das Schreiben, die Verwendung und die Pflege von Code haben, ist eine einzige häufige Frustration das Fehlen einer guten Dokumentation. "Was sind die Nebeneffekte dieser Methode?" "Ich bekomme einen Fehler nach Schritt 3." "Was bedeutet dieses Akronym?" "Ist dieses Dokument auf dem neuesten Stand?" Jeder Softwareentwickler hat sich im Laufe seiner Karriere schon einmal über die Qualität, die Quantität oder das Fehlen von Dokumentationen beschwert, und die Softwareentwickler bei Google sind da nicht anders.

Technische Redakteure und Projektmanager können zwar helfen, aber Softwareentwickler müssen die meisten Dokumente immer selbst schreiben. Deshalb brauchen sie die richtigen Werkzeuge und Anreize, um dies effektiv zu tun. Der Schlüssel zur Erleichterung des Verfassens qualitativ hochwertiger Dokumentationen liegt in der Einführung von Prozessen und Werkzeugen, die mit dem Unternehmen mitwachsen und sich in den bestehenden Arbeitsablauf einfügen.

Insgesamt ist der Zustand der technischen Dokumentation in den späten 2010er Jahren ähnlich wie der Zustand des Softwaretests in den späten 1980er Jahren. Alle sind sich darüber im Klaren, dass mehr getan werden muss, um sie zu verbessern, aber es gibt noch keine ...