È utile avere autori tecnici in un team di software?

Direi che alla fine si riduce alla capacità dello sviluppatore di scrivere documentazione tecnica e quanta pressione ci sono per svolgere altri lavori relativi allo sviluppo, in quanto ciò ovviamente influirà sulla qualità.

Se hai uno o più sviluppatori che hanno il tempo e le capacità per scrivere documentazione tecnica di qualità, allora sono grandioso, perché nessuno conosce il software meglio dello sviluppatore.

I vantaggi dell'utilizzo di un "outsider" per la documentazione tecnica è che possono scrivere dalla prospettiva utenti e notare cose che lo sviluppatore potrebbe non avere, poiché potrebbe già essere diventato così radicato nella loro routine .

La documentazione può anche essere un riflesso della qualità del software, in quanto potrebbe essere il primo posto che l'utente fa prima di installare / acquistare, specialmente se il pubblico è già tecnico, quindi è importante ottenere questa prima impressione.

Quindi, in sintesi, sì, sono preziosi per qualsiasi squadra e la spesa che sostengono è in definitiva ne vale la pena (non devono essere un appuntamento fisso e si libera anche del tempo di sviluppo).

Gli autori tecnici del mio team si comportano in gran parte come editor.

Comprendiamo il nostro sistema meglio di loro e capiscono meglio la parola scritta di noi.

Come sviluppatori, siamo responsabili della documentazione del nostro lavoro e gli scrittori tecnici lavorano per normalizzare lo stile e la qualità molto diversi che il nostro team produce.

Sono stato uno scrittore tecnico da oltre 20 anni. Molti sviluppatori non amano scrivere documentazione. Se non ti piace fare qualcosa, probabilmente non lo farai bene. Fai un favore a tutti e assumi un professionista. Non ti aspetteresti che scrivano il materiale di marketing o di vendita, vero?

Un buon scrittore tecnico è una risorsa per qualsiasi team di sviluppo. Il nostro ultimo scrittore tecnico era una superstar:

L'ultimo autore tecnico che abbiamo assunto è iniziato intervistando ogni sviluppatore e creando un documento di aiuto, combinato con tutorial, per il nostro software. Ha quindi iniziato a pianificare riunioni periodiche per gli aggiornamenti, nonché a intervistare ciascuno sviluppatore una volta completato i progetti principali, raccogliendo informazioni per l'aggiornamento della documentazione.

Una volta che la nostra documentazione e le nostre esercitazioni erano all'altezza, ha installato un server sharepoint per archiviare tutti i nostri documenti e le conoscenze scritte, che ha costantemente modificato e aggiornato, incluso il monitoraggio dei documenti che non erano stati modificati per settimane o mesi e chiedere agli autori eventuali aggiornamenti. Ha installato una wiki e una base di conoscenza per il nostro team di supporto, che ha ereditato dalle (allora) abbondanti quantità di informazioni che aveva raccolto dagli sviluppatori.

Si è unita al nostro istruttore e lo ha aiutato a scrivere un documento di formazione per eventuali nuovi assunti e potenziali clienti. Si è quindi assicurata che il documento fosse aggiornato e lo avesse modificato per renderlo leggibile e pulito.

Nel corso del tempo, ha costantemente modificato e ripulito tutte le informazioni scritte, che si trattasse di wiki, sharepoint, documenti di prodotto, ecc. Se avesse mai avuto del tempo libero, si offrì volontaria per aiutarci a scrivere qualsiasi presentazione che avremmo dovuto fare ad altre squadre e tra di noi.

È riuscita a diventare un esperto di prodotti lungo la strada e ha continuato ad essere una consulente altamente pagata per uno dei nostri clienti. Eravamo tristi nel vederla andare.