Progetto congelato - cosa dovrei lasciare alle persone dopo di me?

Altre cose da considerare

• La struttura della directory del progetto è sana di mente? Hai rivisto i commenti del codice? Il registro di commit è in qualche modo presentabile?
• Panoramica degli obiettivi di Gerneral (al contrario di quella tecnica, che hai avviato), lettura consigliata del progetto, storia del progetto (sua ciclo di sviluppo, precedenti responsabili di progetto, elenco di personale, requisiti / specifica funzione)
• Diagrammi UML, diagrammi di classe, diagrammi di flusso di lavoro!
• Le ragioni per cui il progetto è stato congelato sono sempre carine.
• Ambiente di sviluppo, IDE che sono stati utilizzati, strumenti di sviluppo, questi sono trattati nei documenti tecnici giusto?

Ho appena pensato ad alcune delle cose che avrei voluto vedere su un progetto che ho ereditato di recente. Quello che hai già fornito è molto più di quello che ho ottenuto. Riceverai punti karma importanti per aiutare la prossima squadra:)

Le cose che mi piacerebbe avere quando raccolgo un progetto che qualcun altro ha messo giù sono:

Crea istruzioni, incluse le ultime versioni di lavoro conosciute di tutti gli strumenti nella toolchain. Compilatori, IDE, ecc. Cambiano nel tempo, ed è molto più facile lavorare con se gli sviluppatori precedenti mi lasciano le istruzioni su come iniziare a lavorare.

Esegui istruzioni sull'ambiente: cosa deve essere in atto per eseguire questa cosa? Una menzione di quali versioni sono di nuovo utili. Recentemente ho rilevato qualcosa che richiedeva che un certo insieme di file si trovasse in un determinato posto, e ho dovuto interrogare gli altri sviluppatori per capirlo. Non un grosso problema dato che l'altro dev era disponibile, ma se non lo fosse stato, sarebbe stato problematico.

Alcuni assicurano che il codice impegnato nel repository esegue effettivamente il checkout e lo sviluppo. Una volta ho preso un progetto in cui gli sviluppatori precedenti (fortunatamente ancora in giro) avevano fatto cose davvero strane con i Makefile in modo tale da non poter costruire il progetto da una cassa pulita. Inutile dire che prima ho dovuto rettificare QUEL prima di poter effettivamente fare qualsiasi lavoro. Se gli sviluppatori precedenti non fossero stati disponibili, avrebbe potuto richiedere molto più tempo per superare questo ostacolo.

Una dichiarazione generale sull'intento del progetto. A cosa serve questo pezzo di software? Abbastanza ragionevole, ma una sorta di panoramica può essere davvero utile.

A ScreenCast

Quando ho lasciato il mio ultimo lavoro in realtà ho fatto screencast inediti che, da quello che ho sentito, sono stati di grande aiuto nell'assumere nuove persone. Ho portato la mia squadra in una stanza, installato un microfono a condensatore e spiegato loro tutto ciò che sapevo del progetto durante la registrazione dell'audio e dello schermo. Quindi, lascio che mi facciano domande a riguardo. Siamo riusciti a ottenere molte più informazioni registrate di quanto avremmo potuto se mi fossi seduto e avessi provato a digitare il più velocemente possibile tutto il giorno.

Se sei al corrente delle informazioni aggiungi Requisiti aziendali.

1. Che cosa voleva il cliente?
2. In che modo le modifiche lo hanno agevolato?
3. Quali erano o sono alcune delle sfide nel soddisfare i clienti esigenze?
4. Quali esigenze non sono state soddisfatte e perché?

Una immagine di virtualmachine (cioè vm-ware) di un sistema di sviluppo stand-alone potrebbe essere piuttosto preziosa.

L'anno scorso mi è stato chiesto di correggere qualche codice vb3. È stato abbastanza difficile ricreare un sistema in esecuzione con vb3, windows95 e molti ole-controll installati. Dopo una settimana ho rinunciato: - (

[Aggiornamento] Qualcuno ha esperienza nel convertire vecchie immagini di macchine virtuali in modo che possano essere riprodotte in un nuovo lettore di macchine virtuali?

Devi anche considerare che potrebbe non essere più possibile eseguire un'immagine molto vecchia su un moderno sistema hardware / guest.