Documentazione e convenzioni del team
Collaborazione sui progetti
Un README dovrebbe descrivere prerequisiti, installazione, avvio, test e variabili richieste. Le istruzioni usano versioni o vincoli comprensibili e indicano gli eventuali servizi esterni. Un comando che funziona solo nel terminale dell’autore è un segnale di configurazione implicita.
Le convenzioni comprendono nomi dei branch, messaggi, struttura e processo di revisione. Non è necessario duplicare ogni dettaglio in più documenti: una fonte aggiornata e link chiari riducono contraddizioni. Gli esempi di variabili d’ambiente contengono valori innocui e spiegano quali valori vadano forniti localmente.