Ti unisci al team di sviluppo di un'app Android esistente e ti viene consegnato un documento tecnico.
Quali informazioni vorresti che fossero?
Probabilmente non è la risposta che stai cercando, ma non voglio dover leggere un documento tecnico per capire un'applicazione.
Secondo me, il pezzo più importante di documentazione per un progetto sono i test unitari! Ogni volta che mi imbatto in un codice che non capisco l'importanza di, controllo i casi di test. Test chiari e completi possono parlare molto del significato del codice, insieme a tutti gli altri grandi vantaggi.
Un problema con i documenti tecnici è che diventano obsoleti molto rapidamente. A mano a mano che le funzioni vengono aggiunte e il codice sorgente viene refactored, il mantenimento della documentazione diventa un grosso problema.
I documenti tecnici dovrebbero essere rivolti ai tuoi clienti, utenti o partner commerciali, non ai tuoi sviluppatori.
Leggi altre domande sui tag maintenance documentation android