SlideShare a Scribd company logo
Strumenti per creare
documentazione e
manuali tecnici
E 6 cose da fare prima di iniziare
2
CHI SONO
Ho vissuto “dall’interno” le dinamiche delle
aziende B2B industriali in realtà di produzione e
distribuzione, multinazionali e nazionali. Ho
dato il mio contributo sviluppando le attività di
Marketing e comunicazione offline/online e
integrandole con diversi strumenti come ad
esempio il CRM.
Ho deciso di ripartire da questa esperienza e
avviare un nuovo progetto, il blog INTINGO,
per condividere idee B2B e alimentare il talento
con nuove contaminazioni.
Vieni a farci visita: www.intingo.it
Trovi intingob2b anche su:
Gabriella
Mazzon
Realizzare un manuale tecnico
è un processo con competenze
diverse.
3
Vediamo gli strumenti a disposizione e
i primi 6 punti da verificare per
realizzare la documentazione tecnica
industriale B2B.
1.
IMPAGINAZIONE
AUTOMATICA
Ideale per documenti
complessi e multilingua
“
L’impaginazione automatica è
il sistema centralizzato di
gestione della produzione dei
cataloghi, manuali listini che si
basa su un database in cui
vengono memorizzati tutti i
dati relativi ai prodotti.
5
La grafica è separata
dai dati
Significa che se si vuole
modificare
l’impostazione grafica
non si deve riscrivere
l’intero manuale.
I vantaggi dell’impaginazione
automatica
I dati sono gestiti
con un database
Se l’informazione (un dato
tecnico, porzione di testo,
immagine, codice ecc.)
cambia, viene aggiornata una
sola volta nel database e in
automatico si aggiornano
tutti i documenti che
riportano quella
informazione.
6
I vantaggi dell’impaginazione
automatica
▹ facilità di modifica della grafica perché è scollegata dai
dati. Realizzata la nuova grafica basta ripopolare il
documento e si ottiene il nuovo catalogo,
▹ facilità nella gestione dei cataloghi multilingua: come
abbiamo detto il dato si cambia solo una volta nel
database e tutti i documenti che lo riportano vengono
aggiornati in automatico,
▹ produzione multicanale: cartaceo, PDF, ePub, APP
▹ gestione collaborativa, ciascuno dipartimento aggiorna la
sua porzione di dati. Il sistema gestisce le revisioni, i
controllori, le approvazioni.
7
2.
VALUTAZIONE
DELLE RISORSE
Uffici interni, technical writer
“
La gestione dei cataloghi
è demandata a uffici
interni o alla
collaborazione con una
persona specializzata
nella redazione tecnica di
manuali.
9
E’ uno scrittore…
Il TW comprende
appieno il
funzionamento del
prodotto e lo sa
portare nella scrittura
affinché sia fruibile da
un determinato
pubblico.
Chi è il technical writer (TW)
E’ uno scrittore specializzato
In genere, lo specialista di
scrittura tecnica si dedica a
certe tipologie di prodotto,
poiché è diverso scrivere di
un software o di una una
macchina utensile.
10
11
Come scegliere un TW
▹ La distanza conta: se non è vicino organizza interviste via
Skype (o similare) con i tecnici.
▹ Deve conoscere strumenti di Office Automation
▹ Deve conoscere strumenti di lavoro collaborativo puoi
pensare di utilizzare strumenti come Google Drive e Google
Docs.
▹ Deve essere capace di proporti un piano di lavoro di
massima fin dal primo colloquio, indicandoti qual è la sua
metodologia.
▹ Deve sapersi relazionare con il grafico Se non usi sistemi di
impaginazione elettronica deve essere in grado di trasferire
le informazioni al grafico e di indicare come vengono
impaginati i testi, le tabelle, le immagini, le didascalie, le note
ecc.
3.
6 PUNTI PER INIZIARE
Alcuni suggerimenti prima di
metterti all’opera
NORME E FORMA
1. Normative
particolari
Individua se nel tuo
mercato esistono
normative riferite ai
manuali tecnici. Ad
esempio se deve essere
tradotto nella lingua
del paese in cui viene
esportato il prodotto.
2. Forma di
comunicazione tecnica
Tenendo presente il
tuo mercato di
riferimento, la
competenza specifica o
meno degli operatori
destinatari del manuale
devi individuare qual è
il tono più appropriato.
3. Testa se la forma di
comunicazione attuale
Se l’installazione del
tuo prodotto richiede
la presenza del
personale della tua
azienda puoi chiedere
loro di svolgere
l’installazione e la
formazione facendo
seguire all’operatore
passo passo il manuale.
13
SUPPORTO, CANALI, SME
4. Individua il supporto
migliore
Cartaceo e/o digitale il
supporto scelto
influisce sulla modalità
di fruizione del
manuale e dei suoi dati
come tabelle e disegni
tecnici.
5. Individua i canali
Ad esempio se pensi di
realizzare anche la
versione in PDF devi
progettare una
navigazione per titoli e
Hyperlink. Puoi
prevedere webinar o
elearning? Se prevedi
fin dall’inizio l’utilizzo
su canali differenti ti
sarà più facile in
seguito adattare le
informazioni a ciascuno
di essi.
6. Individua i tuoi SME
Potresti avere più
figure tecniche da
coinvolgere a seconda
delle parti del
prodotto, ad esempio,
l’ingegnere meccanico
e quello elettronico.
Individua i tuoi SME
(Subject Matter Expert)
per velocizzare il
lavoro.
14
4.
CUSTOMER EXPERIENCE
La documentazione tecnica contribuisce
alla esperienza che il tuo cliente ha della
tua azienda
OGNI DOCUMENTO RAPPRESENTA L’AZIENDA
16
Se già non lo fai, è ora che verifichi lo stato dell’arte della
documentazione tecnica prodotta all’interno della tua azienda.
Verifica il tratto che distingue la documentazione
da quella dei concorrenti.
Vuoi saperne di più?
17
Cos’è intingo?
E’ il blog dedicato agli
argomenti più attuali nel
B2B.
Realizzato da professionisti
con decenni di esperienza in
aziende B2B in particolare
del settore industriale.
Si parla anche
di Marketing?
Sì e trovi anche risorse,
video, guide pratiche per il
tuo lavoro quotidiano
Ma solo marketing
digitale?
No, ci occupiamo anche
delle attività di
comunicazione più
tradizionali come la
realizzazione di brochure,
l’organizzazione delle fiere,
la documentazione tecnica e
molto altro ancora.
E per quanto riguarda la
comunicazione digitale?
Trovi articoli, informazioni,
spunti e risorse gratuite su
Inbound marketing, content
marketing, email marketing,
landing pages, lead
management e molto altro.
Trova Intingo
in:
Ecco l’articolo completo su Intingo
CREDITS
Special thanks to all the people who made and released
these awesome resources for free:
▹ Presentation template by SlidesCarnival
▹ Photographs by Unsplash
18

More Related Content

Similar to Strumenti per realizzare documentazione e i manuali tecnici B2B

Cv slide share
Cv slide shareCv slide share
Cv slide share
valter venturini
 
Intro OPENSUITE09NR.pdf
Intro OPENSUITE09NR.pdfIntro OPENSUITE09NR.pdf
Intro OPENSUITE09NR.pdf
Mayking
 

Similar to Strumenti per realizzare documentazione e i manuali tecnici B2B (20)

Ecollab Formazione Csp 200904
Ecollab Formazione Csp 200904Ecollab Formazione Csp 200904
Ecollab Formazione Csp 200904
 
Sydav PDF 3D
Sydav PDF 3DSydav PDF 3D
Sydav PDF 3D
 
Le sfide delle intranet: un approccio a coinvolgimento diffuso
Le sfide delle intranet: un approccio a coinvolgimento diffusoLe sfide delle intranet: un approccio a coinvolgimento diffuso
Le sfide delle intranet: un approccio a coinvolgimento diffuso
 
brochure acg enterprise short
brochure acg enterprise shortbrochure acg enterprise short
brochure acg enterprise short
 
RAMCUBE AG - software and services
RAMCUBE AG - software and servicesRAMCUBE AG - software and services
RAMCUBE AG - software and services
 
Strumenti digitali per professionisti e imprese 2021
Strumenti digitali per professionisti e imprese 2021Strumenti digitali per professionisti e imprese 2021
Strumenti digitali per professionisti e imprese 2021
 
Argo CMS: demo online e versione di prova gratuita (trial)
Argo CMS: demo online e versione di prova gratuita (trial)Argo CMS: demo online e versione di prova gratuita (trial)
Argo CMS: demo online e versione di prova gratuita (trial)
 
EPromoWeb
EPromoWebEPromoWeb
EPromoWeb
 
Cv slide share
Cv slide shareCv slide share
Cv slide share
 
Intro OPENSUITE09NR.pdf
Intro OPENSUITE09NR.pdfIntro OPENSUITE09NR.pdf
Intro OPENSUITE09NR.pdf
 
Software per realizzare manuali e documentazione tecnica: Argo CCMS di KEA
Software per realizzare manuali e documentazione tecnica: Argo CCMS di KEASoftware per realizzare manuali e documentazione tecnica: Argo CCMS di KEA
Software per realizzare manuali e documentazione tecnica: Argo CCMS di KEA
 
Brochure polyedro embyon (1)
Brochure polyedro embyon (1)Brochure polyedro embyon (1)
Brochure polyedro embyon (1)
 
Manuale Agile Stelnet
Manuale Agile StelnetManuale Agile Stelnet
Manuale Agile Stelnet
 
La Business Intelligence per le PMI - Vantaggi ed un minimo di contesto
La Business Intelligence per le PMI - Vantaggi ed un minimo di contestoLa Business Intelligence per le PMI - Vantaggi ed un minimo di contesto
La Business Intelligence per le PMI - Vantaggi ed un minimo di contesto
 
Come si presenta un project work aziendale
Come si presenta un project work aziendaleCome si presenta un project work aziendale
Come si presenta un project work aziendale
 
Tool comunicazione organizzazione 1/6
Tool comunicazione organizzazione 1/6Tool comunicazione organizzazione 1/6
Tool comunicazione organizzazione 1/6
 
Depliant_TeamSystem_Alyante_Start
Depliant_TeamSystem_Alyante_StartDepliant_TeamSystem_Alyante_Start
Depliant_TeamSystem_Alyante_Start
 
CurriculumVitae_Paola_Ghione_gennaio2024
CurriculumVitae_Paola_Ghione_gennaio2024CurriculumVitae_Paola_Ghione_gennaio2024
CurriculumVitae_Paola_Ghione_gennaio2024
 
Ambienti software per l'apprendimento in rete
Ambienti software per l'apprendimento in reteAmbienti software per l'apprendimento in rete
Ambienti software per l'apprendimento in rete
 
Linee guida per la progettazione documentale
Linee guida per la progettazione documentaleLinee guida per la progettazione documentale
Linee guida per la progettazione documentale
 

More from Gabriella Mazzon

More from Gabriella Mazzon (13)

SMarketing nelle aziende B2B: moda o opportunità?
SMarketing nelle aziende B2B: moda o opportunità?SMarketing nelle aziende B2B: moda o opportunità?
SMarketing nelle aziende B2B: moda o opportunità?
 
Come fare una cartella stampa digitale
Come fare una cartella stampa digitaleCome fare una cartella stampa digitale
Come fare una cartella stampa digitale
 
10 trend per il marketing aziendale nel 2019
10 trend per il marketing aziendale nel 201910 trend per il marketing aziendale nel 2019
10 trend per il marketing aziendale nel 2019
 
Come organizzare la comunicazione natalizia B2B
Come organizzare la comunicazione natalizia B2BCome organizzare la comunicazione natalizia B2B
Come organizzare la comunicazione natalizia B2B
 
Marketing B2B: come fare il budget marketing
Marketing B2B: come fare il budget marketingMarketing B2B: come fare il budget marketing
Marketing B2B: come fare il budget marketing
 
Creare una landing page: un esempio pratico
Creare una landing page: un esempio praticoCreare una landing page: un esempio pratico
Creare una landing page: un esempio pratico
 
Cos’è il CRM e perché è così importante per il marketing aziendale?
 Cos’è il CRM e perché è così importante per il marketing aziendale? Cos’è il CRM e perché è così importante per il marketing aziendale?
Cos’è il CRM e perché è così importante per il marketing aziendale?
 
Invio di newsletter B2B: 11 consigli per scegliere il tuo servizio di email m...
Invio di newsletter B2B: 11 consigli per scegliere il tuo servizio di email m...Invio di newsletter B2B: 11 consigli per scegliere il tuo servizio di email m...
Invio di newsletter B2B: 11 consigli per scegliere il tuo servizio di email m...
 
Come convertire i visitatori in contatti nel tuo sito aziendale B2B
Come convertire i visitatori in contatti nel tuo sito aziendale B2BCome convertire i visitatori in contatti nel tuo sito aziendale B2B
Come convertire i visitatori in contatti nel tuo sito aziendale B2B
 
Come scegliere un consulente SEO nel B2B?
Come scegliere un consulente SEO nel B2B?Come scegliere un consulente SEO nel B2B?
Come scegliere un consulente SEO nel B2B?
 
Pubblicità B2B offline: come creare una pagina pubblicitaria
Pubblicità B2B offline: come creare una pagina pubblicitariaPubblicità B2B offline: come creare una pagina pubblicitaria
Pubblicità B2B offline: come creare una pagina pubblicitaria
 
9 regole per il successo del tuo content marketing B2B
9 regole per il successo del tuo content marketing B2B9 regole per il successo del tuo content marketing B2B
9 regole per il successo del tuo content marketing B2B
 
Come promuovere una fiera B2B
Come promuovere una fiera B2BCome promuovere una fiera B2B
Come promuovere una fiera B2B
 

Strumenti per realizzare documentazione e i manuali tecnici B2B

  • 1. Strumenti per creare documentazione e manuali tecnici E 6 cose da fare prima di iniziare
  • 2. 2 CHI SONO Ho vissuto “dall’interno” le dinamiche delle aziende B2B industriali in realtà di produzione e distribuzione, multinazionali e nazionali. Ho dato il mio contributo sviluppando le attività di Marketing e comunicazione offline/online e integrandole con diversi strumenti come ad esempio il CRM. Ho deciso di ripartire da questa esperienza e avviare un nuovo progetto, il blog INTINGO, per condividere idee B2B e alimentare il talento con nuove contaminazioni. Vieni a farci visita: www.intingo.it Trovi intingob2b anche su: Gabriella Mazzon
  • 3. Realizzare un manuale tecnico è un processo con competenze diverse. 3 Vediamo gli strumenti a disposizione e i primi 6 punti da verificare per realizzare la documentazione tecnica industriale B2B.
  • 5. “ L’impaginazione automatica è il sistema centralizzato di gestione della produzione dei cataloghi, manuali listini che si basa su un database in cui vengono memorizzati tutti i dati relativi ai prodotti. 5
  • 6. La grafica è separata dai dati Significa che se si vuole modificare l’impostazione grafica non si deve riscrivere l’intero manuale. I vantaggi dell’impaginazione automatica I dati sono gestiti con un database Se l’informazione (un dato tecnico, porzione di testo, immagine, codice ecc.) cambia, viene aggiornata una sola volta nel database e in automatico si aggiornano tutti i documenti che riportano quella informazione. 6
  • 7. I vantaggi dell’impaginazione automatica ▹ facilità di modifica della grafica perché è scollegata dai dati. Realizzata la nuova grafica basta ripopolare il documento e si ottiene il nuovo catalogo, ▹ facilità nella gestione dei cataloghi multilingua: come abbiamo detto il dato si cambia solo una volta nel database e tutti i documenti che lo riportano vengono aggiornati in automatico, ▹ produzione multicanale: cartaceo, PDF, ePub, APP ▹ gestione collaborativa, ciascuno dipartimento aggiorna la sua porzione di dati. Il sistema gestisce le revisioni, i controllori, le approvazioni. 7
  • 9. “ La gestione dei cataloghi è demandata a uffici interni o alla collaborazione con una persona specializzata nella redazione tecnica di manuali. 9
  • 10. E’ uno scrittore… Il TW comprende appieno il funzionamento del prodotto e lo sa portare nella scrittura affinché sia fruibile da un determinato pubblico. Chi è il technical writer (TW) E’ uno scrittore specializzato In genere, lo specialista di scrittura tecnica si dedica a certe tipologie di prodotto, poiché è diverso scrivere di un software o di una una macchina utensile. 10
  • 11. 11 Come scegliere un TW ▹ La distanza conta: se non è vicino organizza interviste via Skype (o similare) con i tecnici. ▹ Deve conoscere strumenti di Office Automation ▹ Deve conoscere strumenti di lavoro collaborativo puoi pensare di utilizzare strumenti come Google Drive e Google Docs. ▹ Deve essere capace di proporti un piano di lavoro di massima fin dal primo colloquio, indicandoti qual è la sua metodologia. ▹ Deve sapersi relazionare con il grafico Se non usi sistemi di impaginazione elettronica deve essere in grado di trasferire le informazioni al grafico e di indicare come vengono impaginati i testi, le tabelle, le immagini, le didascalie, le note ecc.
  • 12. 3. 6 PUNTI PER INIZIARE Alcuni suggerimenti prima di metterti all’opera
  • 13. NORME E FORMA 1. Normative particolari Individua se nel tuo mercato esistono normative riferite ai manuali tecnici. Ad esempio se deve essere tradotto nella lingua del paese in cui viene esportato il prodotto. 2. Forma di comunicazione tecnica Tenendo presente il tuo mercato di riferimento, la competenza specifica o meno degli operatori destinatari del manuale devi individuare qual è il tono più appropriato. 3. Testa se la forma di comunicazione attuale Se l’installazione del tuo prodotto richiede la presenza del personale della tua azienda puoi chiedere loro di svolgere l’installazione e la formazione facendo seguire all’operatore passo passo il manuale. 13
  • 14. SUPPORTO, CANALI, SME 4. Individua il supporto migliore Cartaceo e/o digitale il supporto scelto influisce sulla modalità di fruizione del manuale e dei suoi dati come tabelle e disegni tecnici. 5. Individua i canali Ad esempio se pensi di realizzare anche la versione in PDF devi progettare una navigazione per titoli e Hyperlink. Puoi prevedere webinar o elearning? Se prevedi fin dall’inizio l’utilizzo su canali differenti ti sarà più facile in seguito adattare le informazioni a ciascuno di essi. 6. Individua i tuoi SME Potresti avere più figure tecniche da coinvolgere a seconda delle parti del prodotto, ad esempio, l’ingegnere meccanico e quello elettronico. Individua i tuoi SME (Subject Matter Expert) per velocizzare il lavoro. 14
  • 15. 4. CUSTOMER EXPERIENCE La documentazione tecnica contribuisce alla esperienza che il tuo cliente ha della tua azienda
  • 16. OGNI DOCUMENTO RAPPRESENTA L’AZIENDA 16 Se già non lo fai, è ora che verifichi lo stato dell’arte della documentazione tecnica prodotta all’interno della tua azienda. Verifica il tratto che distingue la documentazione da quella dei concorrenti.
  • 17. Vuoi saperne di più? 17 Cos’è intingo? E’ il blog dedicato agli argomenti più attuali nel B2B. Realizzato da professionisti con decenni di esperienza in aziende B2B in particolare del settore industriale. Si parla anche di Marketing? Sì e trovi anche risorse, video, guide pratiche per il tuo lavoro quotidiano Ma solo marketing digitale? No, ci occupiamo anche delle attività di comunicazione più tradizionali come la realizzazione di brochure, l’organizzazione delle fiere, la documentazione tecnica e molto altro ancora. E per quanto riguarda la comunicazione digitale? Trovi articoli, informazioni, spunti e risorse gratuite su Inbound marketing, content marketing, email marketing, landing pages, lead management e molto altro. Trova Intingo in: Ecco l’articolo completo su Intingo
  • 18. CREDITS Special thanks to all the people who made and released these awesome resources for free: ▹ Presentation template by SlidesCarnival ▹ Photographs by Unsplash 18