Documentazione e consegna del codice sorgente

3

Recentemente ho lasciato il mio precedente lavoro da studente come sviluppatore part-time presso la piccola società di gestione ERP.

Durante il mio periodo presso l'azienda ho sviluppato diversi moduli per l'integrazione con il sistema ERP. Inoltre ho sviluppato un'applicazione e un back-end per tale applicazione.

Mi è stato chiesto di documentare le parti complesse del mio codebase, in modo che un altro sviluppatore possa essere in grado di sviluppare ulteriormente.

C'è qualche buona pratica nel consegnare il codice sorgente, come devo documentare e in quale estensione dovrei documentare?

Come ultima nota non ho effettuato alcun test o documentazione del codice, ad eccezione dei commenti per aiutare a navigare nella struttura del codice. Il proprietario del prodotto semplicemente non voleva che spendessi del tempo per quelle attività.

Qualsiasi input è apprezzato!

    
posta BastianBuhrkall 31.08.2016 - 14:49
fonte

0 risposte

Leggi altre domande sui tag