Non ci sarà alcuna documentazione o ci sarà poca documentazione, o non sarà aggiornata. Trova tutta la documentazione che esiste. Se si trova nel repository di un gruppo, non fare una copia. In caso contrario, mettilo lì e chiedi al tuo manager il permesso di organizzarlo, magari con un po 'di supervisione.
Porta tutto nel repository del team e aggiungi un glossario. Tutte le basi hanno un gergo; documentarlo nel glossario. Crea sezioni per strumenti, prodotti, specifiche del cliente, ecc.
Crea / Aggiorna un documento di creazione dell'ambiente software. Tutti gli strumenti, i quirk, le opzioni di installazione ecc. Vanno qui.
Quindi carica un documento introduttivo con "ProductName" o simili. Lascia che sia solo il flusso mentale e si auto-organizzi nel tempo. Quindi consulta i documenti non aggiornati e ripristinali. Gli altri sviluppatori lo apprezzeranno, contribuirai in modo unico mentre impari il codice. Soprattutto, documenta tutte le cose che ti pungono o che hanno un nome errato o che sono contro-intuitive.
Una volta terminata la curva di inclinazione, non preoccuparti dell'aggiornamento della documentazione. Lascia che il prossimo nuovo ragazzo lo faccia. Quando arriva, indirizzalo al tuo lavoro. Quando ti infastidisce continuamente per avere delle risposte, non rispondergli. Piuttosto, aggiungi la domanda alla tua documentazione e poi consegnagli l'url. Canna da pesca.
Un effetto collaterale è che avrai creato uno strumento a cui puoi riferirti da mesi quando dimentichi.
E sebbene non si tratti di documentazione, un problema correlato è costituito dalle piccole e stravaganti procedure manuali che fanno i tuoi compagni di squadra. Automatizzali con batch, script sql e simili, e condividi anche quelli. Dopotutto, la conoscenza procedurale è discutibilmente grande quanto la conoscenza dichiarativa in termini di produttività in un nuovo ambiente. Qualunque cosa sia, non farlo; piuttosto, lo script, ed esegui lo script. La canna da pesca colpisce ancora.
