Il mio capo desidera una spiegazione inglese linea per linea del nostro codice

155

Mi è stato specificamente chiesto di dare una spiegazione riga per riga (o come appropriato - per esempio, immagine per immagine, ecc.) che il mio capo vuole essere in grado di leggere e seguire.

Poiché non è un programmatore, non può seguire il codice, quindi vuole che tutto sia tradotto in inglese.

Qualcuno è stato invitato a farlo prima?

Ho commentato tutto il codice sorgente e ho usato JSDoc per generare una documentazione completa di tutte le funzioni, variabili, ecc. ... e includeva un esempio di implementazione e dimostrazioni di lavoro complete con commenti in tutto.

C'è altro che posso fare per commentare il codice per i non programmatori?

Questa non è una richiesta ragionevole, vero?

UPDATE

Alla fine, sono riuscito a spiegare perché non era un buon uso del tempo per fare ciò che stava chiedendo. È un ragazzo ragionevole, e non capisce cosa comporta il mio lavoro. Una volta visto questo post, penso che abbia capito rapidamente che non era una richiesta normale.

Ho fornito una documentazione che è adatta per un altro programmatore da seguire (JSDoc e commenti in linea - così come alcune note extra su problemi tecnici) e un diagramma di diagramma molto ampio della logica principale del programma per il mio capo seguire.

Alla fine, tutte le parti sono state soddisfatte e ci siamo trasferiti.

    
posta Billy Moon 24.10.2011 - 16:09
fonte

0 risposte

Leggi altre domande sui tag