Show More
Menu
Image
Hi there! I am Federico Trotta

Technical Writer

3 Ragioni Per Cui Non Dovresti Affidare la Documentazione Tecnica ad una Agenzia

18/01/2024
By Federico
0 Comments
Post Image

E’ arrivato il momento. Hai finalmente preso la decisione: ti serve un Technical Writer.

Di lavoro ne avrà da fare: il prodotto è abbastanza maturo, hai problemi di clienti che ti aprono un sacco di ticket di supporto perché non sanno usare il prodotto, sovraccaricando di lavoro gli ingegneri del supporto, e vorresti anche valutare di documentare il codice del tuo prodotto. Sia mai che qualcuno se ne vada a breve dall’azienda e chi lo sostituirà dovrà spendere un sacco si tempo a farsi formare dai colleghi, che già non hanno tempo.

Il budget c’è, ma c’è un problema: non sai a chi rivolgerti.

Poi ti ricordi di quella tua conoscenza che “scrive cose” e lavora in una nota agenzia. Decidi, quindi, di chiamare l’agenzia.

Fissati il lavoro ed il prezzo, si parte.

Però, aspetta, col passare dei giorni inizi a vedere dei problemi:

  • La figura che deve svolgere il lavoro non è autonoma, anche se è senior.
  • Non è stato implementato un processo per inserire la figura, seppur esterna, in un quadro lavorativo che le permetta di muoversi sul prodotto, facendo le giuste domande a chi lo conosce.
  • La persona designata non ha un perimetro chiaro del suo lavoro, per cui viene subissata di richieste, non sapendo come gestirle.
  • Nonostante l’inserimento di questa figura, continua ad esserci un elevato numero di ticket aperti al supporto dai clienti perché non sanno come usare il tuo prodotto.

E la lista potrebbe continuare.

E sai qual è il punto? Semplice: non stai lavorando con uno specialista della documentazione tecnica legata al software.

Ecco, quindi, 3 motivi per cui non dovresti affidare la documentazione ad un’agenzia:

  1. Se ti affidi ad un’agenzia di marketing, le figure inserite in organico sanno lavorare, beh…nel marketing! Per quanto la scrittura di blog post sia similare ad un articolo tecnico per alcuni aspetti, per altri aspetti “saper scrivere cose” non basta.
  2. Esistono alcune agenzie che fanno documentazione tecnica ma, in generale, sono orientate a settori diversi dall’IT. Il caso tipico è quello di chi sviluppa manuali d’uso per il settore metalmeccanico. Ecco, anche se in quel caso chi lavora in agenzia ha esperienza e capacità tecnica, si tratta di un lavoro completamente diverso da quello del Technical Writer nell’IT.
  3. Come succede in tutti i settori, il turnover del personale è, in generale, molto alto. Partendo da zero, avrai bisogno di portare avanti un progetto documentale per diversi mesi: questo potrebbe significare che la figura di riferimento, dopo qualche settimana, cambierà lavoro e te ne sarà affidata un’altra, col rischio di dover ricominciare tutto da capo.

Quello di cui hai bisogno, partendo da zero, è un professionista che:

  • Sia indipendente nel testare il prodotto, avendo conoscenze e competenze tecniche specifiche, legate al mondo IT.
  • Si appoggi meno possibile agli sviluppatori ed agli altri reparti, lavorando in autonomia, coinvolgendoli solo quando sia strettamente necessario.
  • Progetti la documentazione, facendo un piano a lungo termine.
  • Comprenda e stabilisca chi sono gli utenti tipo del tuo prodotto, per creare la documentazione ad hoc per loro.
  • Sia in grado si scegliere tra un ventaglio di software per scrivere la documentazione quale sia quello che più si adatti al tuo caso.
  • Raccolga feedback degli utenti e modifichi la documentazione sulla base di questi.In sostanza, ti serve un professionista del settore: non una persona qualunque “che sa scrivere bene”.

Hai bisogno di implementare un progetto di documentazione tecnica ma non sai come partire? Continua a leggere!

Ciao, sono Federico e sono un Technical Writer freelance:

Federico Trotta

Vuoi collaborare con me? Contattami!

Vuoi saperne di più su come lavoro? Puoi partire dai miei case studies e dal mio portfolio.

Federico Trotta

Technical Writer: I document digital products and write articles about AI & Python programming.

Leave a reply