Statistiche sulla percentuale media di tempo richiesta per creare documentazione "utilizzabile"

So, all the sudden there's an interest in creating documentation for the project... that's 100% turn-key, meaning that someone with no understanding of anything, would be able to do everything required to duplicate the work done.

In realtà vogliono una documentazione per gli sviluppatori o l'utente? A me sembra che sia la prima, ma non è chiaro.

Direi che è un'aspettativa completamente non realistica . Ovviamente a seconda di cosa "nessuna comprensione di qualcosa" in realtà significa: una persona senza background di programmazione? o uno non esperto nella lingua / piattaforma / dominio specifici? O ...?

Comunque, scrivere una documentazione così dettagliata è un compito enorme , molto più adatto per uno scrittore di documenti professionale che uno (per quanto esperto) sviluppatore. E il suo risultato diventerebbe rapidamente obsoleto - più i documenti sono dettagliati, più velocemente non si sincronizza con il codice .

È impossibile rispondere perché il significato di utilizzabile dipende dal tuo caso specifico. Dandoci più precisioni renderemo la domanda troppo localizzata.

Quindi non posso solo rispondere che tali statistiche non esistono e se esistono non sono affidabili.

Per risolvere il problema, di solito costruisco la documentazione su richiesta dopo aver fatto le cose di base. Una sorta di caricamento pigro per la documentazione.

there's an interest in creating documentation for the project... that's 100% turn-key, meaning that someone with no understanding of anything, would be able to do everything required to duplicate the work done

Sfortunatamente quel livello di precisione significa che la documentazione del tuo progetto deve includere minuti su tutte le decisioni e i trade-off che sono stati fatti, da chi e perché la decisione di quella persona è stata autorevole: è molto difficile ricostruire ex post facto . Fortunatamente quel livello di precisione è quasi certamente inutile, perché il tuo progetto è già stato completato: nessuno ha mai realmente bisogno di duplicarlo. Anche nel calcolo scientifico in cui le persone devono essere in grado di riprodurre i reciproci risultati, siamo autorizzati a utilizzare gli strumenti degli altri per aiutare.

Quindi penso che la risposta sia scoprire quali sono i veri requisiti della documentazione, quindi seguire la normale routine di stima per capire quanto tempo ci vuole per soddisfare tali requisiti. Nei progetti successivi, è possibile pianificare la documentazione come parte del lavoro del progetto e impiegare meno tempo perché non è necessario eseguire la retroingegnerizzazione del progetto alla fine.

"all'improvviso c'è interesse a creare documentazione per il progetto ... è il 100% chiavi in mano, il che significa che qualcuno senza alcuna comprensione di qualcosa, sarebbe in grado di fare tutto il necessario per duplicare il lavoro svolto."

Questo richiede molto più tempo di quanto pensi!

Non sottovalutarlo. Il tipo di documentazione a cui ti riferisci richiede uno scrittore tecnico decente e non dovrebbe essere scritto da qualcuno che è 'vicino' al codice. Hai bisogno di una vista esterna del sistema.

Deve essere scritto, rivisto, rivisto. Deve essere testato contro il software. Deve essere mantenuto con il software. Forse ha bisogno di traduzione. Se non lo fai bene, non verrà usato. È una percentuale significativa del tempo impiegato per scrivere il software originale.

Tutto dipende dalla semplice risposta che ho paura, ma non sottovalutarlo.

Inizia elencando i documenti che desiderano e inserendo un numero grande accanto a esso, non lo so, diciamo 5 giorni.

Il try e il punto elenco puntano su ogni documento necessario e lo prendi da lì.