Sono uno sviluppatore dilettante e fino ad ora tutti i miei programmi erano abbastanza semplici da essere documentati nel codice. Durante la lettura del codice è stato chiaro cosa stavo facendo così e tale azione (il mio test standard era quello di guardare il codice 6 mesi dopo e capire tutto a prima lettura - e ho una breve durata della memoria).
Ora sto affrontando un programma che sta superando le mie capacità di ricordare le varie interazioni tra
- il codice stesso
- gli indici nel database
- le interazioni tra i vari moduli (codice core "worker" e codice "library")
La mia attuale documentazione è una lavagna in cui ho tutti i tipi di caselle e frecce che puntano a codice, a indici di database, a azioni in esecuzione, a cambiamenti di stato, ecc. Solo per riferimento, un frammento del pasticcio:
La mia domanda è se esiste una serie standard o denominata di migliori pratiche (denominata nel senso che si tratta di una serie di pratiche raggruppate con un nome specifico) per la documentazione di prodotti più complessi.
Quali sono le parole chiave che dovrei cercare (tentativi generali di "documentare gli standard di architettura del software" e variazioni simili di solito hanno portato a software per flussi di lavoro o sistemi CAD di architettura di edifici).
Mi aspetto anche che non esistano buone pratiche generali per le descrizioni di alto livello e che ognuno costruisca la propria filosofia.