Processo di consegna del codice sorgente a un cliente [chiuso]

Fai una copia del codice.

Prendi quella copia del codice su un altro computer e verifica che sia possibile creare l'applicazione su quel computer dal codice.

Se non funziona, risolvi tutti i problemi nel codice finché non funziona per creare l'applicazione sul tuo computer e sul secondo computer.

Documentate tutti i passaggi necessari per creare l'applicazione, in modo che un'altra persona possa creare l'applicazione usando solo queste istruzioni. Quando documenti i passaggi, presumi che il lettore possa leggere le istruzioni, ma non la tua mente.

Fornisci il codice e le istruzioni a una segretaria della tua azienda oa tua madre e assicurati che possano compilare l'applicazione seguendo le istruzioni senza fare domande.

Finché questo non funziona, migliori le istruzioni.

A quel punto, consegni il codice e le istruzioni al cliente.

Mi avvicinerei a questo come quando consegno a un altro manutentore:

• Includere i file di controllo del codice sorgente in modo che abbiano l'intera cronologia del progetto.
• Assicurati che il codice venga compilato dal sorgente con un solo comando. Niente è più deprimente di dover trascorrere molte ore / giorni prima di compilare.
• Se sono richieste risorse esterne (ad esempio un database), il codice per impostarle dovrebbe far parte del controllo del codice sorgente. (Pensa: Migrazioni e / o ad esempio un file Vagrant per test locali.)

• Documentazione:

  • Una panoramica di alto livello del progetto (i diversi livelli, il loro intento e le loro dipendenze)
  • Configurazione di distribuzione: come distribuire (di nuovo, idealmente con un comando), dove trovare i file di registro, quali firewall, proxy inversi, ... vengono passati, credenziali per i database ecc.
  • Qualunque cosa tu pensi che il tuo cliente possa trarre vantaggio da ... (es: linguaggio ubiquo, decisioni di progettazione / architettoniche ecc.)
  • Ancora più importante, mantieni la documentazione il più breve possibile . Se si consegnano più di 50 pagine di documentazione, è probabile che non verrà mai letto. (dipende tutto dalla dimensione del progetto, naturalmente, ma meno è quasi sempre meglio)

Passando attraverso il codice con il cliente: immagino che dipenda da lui. Se il cliente continuerà a lavorarci subito, passare insieme il codice è un'ottima idea. Non ricorderà tutto ciò che dici e mostrerà, ma avrà un'idea generale del layout del tuo progetto.