La documentazione è la chiave

Best Practice 2: completare i documenti prima del passaggio successivo

Avevo superato i miei master in Computer & Application ed ero così appassionato di scrivere codice sorgente anche senza comprendere e documentare completamente i requisiti. Il documento di progettazione e la documentazione dei casi di test non erano da nessuna parte nel ciclo di vita dello sviluppo del software ... c'era un salto diretto alla codifica.

In fasi successive mi sono trovato in grossi guai e presto me ne sono reso conto Documentation is the Key diventare sviluppatore, tester o architetto di software di successo.

Prima di iniziare a sviluppare software piccolo o grande, dovresti rispondere alle seguenti domande:

  • Dov'è la specifica dei requisiti?

  • Dov'è il documento di analisi dell'impatto?

  • Dov'è il documento di progettazione?

  • Hai documentato correttamente tutti i presupposti e i limiti?

  • Hai esaminato tutti i documenti?

  • Hai ottenuto l'autorizzazione su tutti i documenti da tutte le parti interessate?

Una volta che hai risposte positive a tutte le domande precedenti, sei sicuro e pronto per procedere con la codifica. Molte organizzazioni avrebbero regole rigide da seguire, ma altre no. La migliore pratica è completare tutta la documentazione richiesta e ottenere le approvazioni appropriate prima di procedere per la codifica del software.

Quello che impari oggi, ti prepara per domani!

Quindi, ancora una volta, è una delle migliori pratiche avere la documentazione il più possibile. Pochi documenti importanti, che ti prepareranno per il futuro sono:

  • Approcci progettuali
  • Suggerimenti e trucchi
  • Funzioni speciali, comandi e istruzioni
  • Lezioni imparate
  • Situazioni peculiari
  • Metodi di debug
  • Migliori pratiche
  • Tutto ciò che può aiutarti in futuro

Conservare i documenti elettronicamente non ti costa. Quindi iniziamo a mantenere la documentazione richiesta.