Consegna di un progetto: la checklist dei documenti
Di Redazione Quaderno dei Sistemi
Prepara una consegna leggibile con versione, istruzioni, file necessari e problemi aperti. Verifica il pacchetto da una cartella separata.
Una consegna utile permette al destinatario di individuare la versione, capire da dove iniziare e riconoscere ciò che manca. Non coincide con la copia indiscriminata della cartella di lavoro. Prepara un pacchetto con uno scopo preciso e prova a leggerlo dal punto di vista di chi non ha seguito il progetto.
Preparare un indice essenziale
Elenca file consegnati, istruzioni iniziali, versione e limiti conosciuti. Se un documento rimanda a un percorso presente soltanto sul tuo computer, correggilo. Se servono credenziali, usa il canale concordato per quelle informazioni: non inserirle nel manuale o negli esempi pubblici.
Separare completato e aperto
Una lista dei problemi ancora da risolvere è diversa dalle note delle modifiche già rilasciate. Per ogni punto aperto, descrivi l’effetto osservato e il riferimento alla segnalazione. GitHub Issues è uno dei possibili strumenti per tracciarlo; la struttura del passaggio di consegne resta valida anche con un registro diverso.
Eseguire una prova di lettura
Copia il pacchetto in una cartella separata e apri l’indice. Controlla i collegamenti e la presenza dei file citati. Questa verifica documentale non dimostra che il software funzioni in ogni ambiente: registra separatamente eventuali prove operative, con condizioni e risultati.
Chiudi con una breve nota su come riconoscere gli aggiornamenti successivi. Il destinatario deve poter distinguere il pacchetto ricevuto da una revisione futura senza confrontare a memoria i nomi delle cartelle. Una consegna tracciabile riduce le domande evitabili e lascia visibili quelle che richiedono ancora una decisione.
Continua a leggere
- Un README utile: spiegare il primo risultato, non tutto il progetto
- Numeri di versione: come leggere major, minor e patch