Dokumentation ist der Schlüssel

Best Practice 2 - Vervollständigen Sie Ihre Dokumente vor dem nächsten Schritt

Ich hatte meinen Master in Computer & Anwendung ohnmächtig gemacht und war so leidenschaftlich darin, Quellcode zu schreiben, auch ohne die Anforderungen vollständig zu verstehen und zu dokumentieren. Konstruktionsdokument und Testfalldokumentation befanden sich nirgends im Lebenszyklus der Softwareentwicklung. Es gab einen direkten Sprung zur Codierung.

In späteren Phasen hatte ich große Probleme und bald wurde mir klar Documentation is the Key erfolgreicher Softwareentwickler, Tester oder Architekt zu werden.

Bevor Sie mit der Entwicklung kleiner oder großer Software beginnen, sollten Sie die folgenden Fragen beantworten:

Wo ist die Anforderungsspezifikation?
Wo ist das Dokument zur Wirkungsanalyse?
Wo ist das Designdokument?
Haben Sie alle Annahmen und Einschränkungen richtig dokumentiert?
Haben Sie alle Dokumente überprüft?
Haben Sie alle Dokumente von allen Stakeholdern unterschrieben?

Sobald Sie positive Antworten auf alle oben genannten Fragen haben, sind Sie sicher und bereit, mit der Codierung fortzufahren. Viele Organisationen hätten strenge Regeln zu befolgen, andere jedoch nicht. Es wird empfohlen, alle erforderlichen Unterlagen auszufüllen und die entsprechenden Genehmigungen einzuholen, bevor Sie mit der Softwarecodierung fortfahren.

Was Sie heute lernen, bereitet Sie auf morgen vor!

Daher ist es wieder eine der besten Methoden, so viel Dokumentation wie möglich zu haben. Einige wichtige Dokumente, die Sie auf die Zukunft vorbereiten, sind:

Designansätze
Tipps und Tricks
Spezielle Funktionen, Befehle und Anweisungen
Stunden gelernt
Besondere Situationen
Debugging-Methoden
Empfohlene Vorgehensweise
Alles, was Ihnen in Zukunft helfen kann

Die elektronische Aufbewahrung von Dokumenten kostet Sie nichts. Beginnen wir also mit der Pflege der erforderlichen Dokumentation.