Technical Writing &

Communication

Linda Finardi

Scrivere
per il web

Manuale operativo
2011
Scrivere per il web
Manuale operativo

Strumento di supporto agli autori di documentazione per il

web.
A tale fine sono state formalizzate alcune regole di scrittura
mutuate dalla disciplina del Technical Writing e alcune
regole per l’ottimizzazione sui motori di ricerca mutuate
dalle tecniche del SEO (Search Engine Optimization).

1. Conoscere l’oggetto di cui scrivere 3

Contenuti

2. Conoscere il lettore web 4

3. Accorgimenti operativi 5
4. Verifica delle Fonti 7
5. Tagging 8
6. Impostazioni grafiche 9
7. Valutazione 10

Approfondimenti 11

Appendici
I. Griglia di valutazione/autovalutazione 12
II. Glossario 13

Linda Finardi - linda.finardi@libero.it 30Gen11 pag. 2

1. Conoscere l’oggetto di cui scrivere

Per conoscere l’oggetto o il tema di cui si scrive è necessario

raccogliere informazioni:

Metodi per la raccolta di informazioni

Interviste a esperti
1 Individuare le persone competenti in materia.
2 Compilare una traccia di intervista con domande
pertinenti allo scopo del documento.
3 Contattare e confrontarsi con gli esperti.

Ricerca materiale sul web

Su siti internet, ebook, blog, forum, etc

Ricerca bibliografica tramite

1 ricerca telematica.
2 persone e conoscenti.
3 direttamente nelle biblioteche.

Linda Finardi - linda.finardi@libero.it 30Gen11 pag. 3

2. Conoscere il lettore web

Capire come si comportano le persone quando cercano

qualcosa online serve per fargli trovare il nostro documento:

Metodi per l’organizzazione delle informazioni

Individuare il destinatario del documento.

1 Individuare interessi, motivi, domande e livello di
competenza dei lettori web che intendiamo
coinvolgere.
2 Individuare gli argomenti e le parole che i potenziali
lettori usano nei motori di ricerca ed includerli nel
documento.
3 In alternativa, individuare argomenti nuovi per nuovi
lettori.

Selezionare il materiale Testuale e Visuale

1 In base allo scopo per cui è stato scritto il testo.
2 Tagliato sulle caratteristiche del destinatario web.

Linda Finardi - linda.finardi@libero.it 30Gen11 pag. 4

3. Accorgimenti operativi

Per rispondere alle esigenze di lettura veloce del lettore,

anche direttamente sullo schermo:

Indicazioni per la stesura del testo

1 Paragrafare.
Mettere una o al massimo due idee/ concetti/
informazioni per paragrafo.
Inserire spazi tra i paragrafi o fra le frasi.
Ridurre al minimo delle parole necessarie per
esprimere il concetto o informare.
Mettere i paragrafi in successione secondo la logica
dell’argomentazione.
Omettere i paragrafi senza frasi essenziali.
Mettere le frasi essenziali all’inizio del paragrafo
2 Evidenziare concetti e parole chiave.
Usare grassetti, sottolineature, corsivi ed
evidenziazioni, ma non eccedere.
3 Perfezionare lo stile.
Evitare frasi subordinate, incisi, parentesi, frasi
riempitive, connettivi.
Preferire la forma soggetto-predicato-complemento
(“chi fa cosa a chi”), con l’uso di pronomi personali,
verbi di azione e forma attiva.

Linda Finardi - linda.finardi@libero.it 30Gen11 pag. 5

 Spiegare le parole specifiche, tecniche, i noeologismi o
le abbreviazioni e indicare per intero gli acronimi.
Includere una sintesi iniziale e una conclusione.
Evitare i bruschi passaggi d’argomento.
Creare il contesto e fornire il necessario background ai
lettori prima di dare nuove informazioni.
Non scrivere parole in maiuscolo. Preferire virgolette e
corsivi.
4 Scegliere titoli e sottotitoli.
Includere le parole che più informano sul testo
generale (per i titoli) o sui paragrafi (per i sottotitoli).
Utilizzare le parole che più vengono usate dai lettori
nei motori di ricerca per trovare argomenti simili.
Preferire parole familiari.
5 Inserire link e riferimenti bibliografici a contenuti
simili o di approfondimento.
6 Utilizzare un indice
7 Fare un abstract
Indicare lo scopo del documento, i motivi per cui è
stato scritto e gli obiettivi.
8 Aggiornare periodicamente il documento.

Linda Finardi - linda.finardi@libero.it 30Gen11 pag. 6

4. Verifica delle Fonti

• Verificare la presenza di diritti d’autore

Mettere il riferimento alla fonte.
Per le opere dell’ingegno di carattere creativo (opere
d’arte, vignette, etc.) preferire immagini i cui autori
siano deceduti da almeno 70 anni.

• Verificare l’attendibilità delle fonti

Preferire siti istituzionali e di persone autorevoli
riconosciute dalla comunità.

Linda Finardi - linda.finardi@libero.it 30Gen11 pag. 7

5. Tagging

L’attività di Tagging può riguardare il titolo, i sottotitoli, il

testo, le immagini, l’autore, le persone citate, l’argomento
più specifico o altri argomenti più generali di cui non si parla
direttamente nell’articolo.

Metodi per la scelta dei tag

1 Immaginare o cercare quali sono le parole utilizzate
l’utente per trovare contenuti simili al vostro
documento.
2 Privilegiare i tag semplici e brevi.
3 Privilegiare tag già usati per altri contenuti perché
sono anche quelli più usati in fase di ricerca.
4 Evitare i tag ridondanti.
5 Cercare di usare meno tag possibili.

Approfondimenti tag

• http://arxiv.org/abs/cs/0701072
• http://www.mestierediscrivere.com/index.php/articolo/t
agging/
•

 














Linda Finardi - linda.finardi@libero.it 30Gen11 pag. 8

6. Impostazioni grafiche

Elementi da scegliere

Formato pagina e margini

Font (stile e dimensioni)

Preferire caratteri senza-grazie (sans-serif).
Es. • senza-grazie (Arial, Helvetica, Tahoma, Trebuchet MS,
Verdana)

• graziati (Times New Roman, Garamond, Bodoni).

Colori
Scegliere colori per scritte e sfondi che non
contrastino e che rendano leggibile la scrittura.

Usare elementi visuali (immagini, foto, tabelle, grafici)

1 Per presentare, sintetizzare o chiarire il contenuto del
documento.
2 Le tabelle organizzarle per colonne
3 Le linee orizzontali possono interrompere lo scrolling;
le linee verticali indicano che c’è altro da leggere.

Nota: preferire modelli grafici già diffusi nel web.

Linda Finardi - linda.finardi@libero.it 30Gen11 pag. 9

7. Valutazione

Deve essere fatta a conclusione del lavoro o anche in fasi

intermedie.

Suggerimenti
1 Far revisionare il documento, cartaceo ed informatico,
ad altre persone: tecnici ed esperti, editori,
supervisori.
2 Richiedere un feedback al lettore tramite strumenti
informatici (in genere già predisposti dai
programmatori) e modificare il documento secondo i
feedback raccolti.
3 Controllare grammatica, sintassi, ortografia,
punteggiatura, concordanza dei verbi.
4 Controllare di non essere usciti fuori tema.
5 Controllare che i titoli e i sottotitoli aiutino ad
evidenziare la logica argomentativa.
6 Controllare gli aspetti grafici.
7 Controllare l’attendibilità e il rispetto dei diritti delle
fonti testuali e visuali.
8 Controllare che il documento risponda alle indicazioni
del manuale.
9 Rileggere il documento dopo due o tre giorni e rifare le
revisioni indicate.

Linda Finardi - linda.finardi@libero.it 30Gen11 pag. 10

Approfondimenti

Technical Writing

• http://www.useit.com/papers/webwriting/writing.html
• Mayfield Electronic Handbook of Technical & Scientific
Writing
• The University of Madison Writing Center
www.wisc.edu/writing/Handbook/ScienceReport.html
• University of Fordham Style Manual
www.library.fordham.edu/res_guid/StyleGuide/StyleGuid
e.html
• Corsi MIT OCW
1. 21W.783 Science and Engineering Writing for Phase II,
Fall 2002 (writing guide: "It's not just salad dressing")
2. 21W.732-5 Introduction to Technical Communication:
Explorations in Scientific and Technical Writing, Fall
2006
3. 21W.780 Communicating in Technical Organizations,
Spring 2005
4. 21W.732-2 Intro to Tech Communication, Fall 2002
5. 21W.785 Communicating in Cyberspace, Fall 2003

Linda Finardi - linda.finardi@libero.it 30Gen11 pag. 11

I. Griglia di Valutazione/ Autovalutazione
Autore: …………………….. Valutazione
Tema: ………………………………………….. -- - * + +
Organizzazione generale:
Adeguatezza Titoli/sottotitoli -- - * + ++
Abstract -- - * + ++
Adeguatezza paragrafazione -- - * + ++
Adeguatezza evidenziazioni -- - * + ++
Stile -- - * + ++
Completezza link e connessioni -- - * + ++
Grammatica, sintassi, ortografia,
-- - * + ++
punteggiatura, concordanza verbi.
Attendibilità e rispetto diritti fonti -- - * + ++
Adeguatezza tag -- - * + ++
Contenuti:
Adeguatezza -- - * + ++
Chiarezza -- - * + ++
Originalità -- - * + ++
Grafica:
Adeguatezza -- - * + ++
Chiarezza -- - * + ++
Attrattività, stile, originalità -- - * + ++
Complessivo:
Soddisfazione uditorio -- - * + ++
Valutazione Complessiva intero
-- - * + ++
documento
Rispetto Date di Consegna -- - * + ++

Linda Finardi - linda.finardi@libero.it 30Gen11 pag. 12

II. Glossario
Con collegamenti ipertestuali
Abstract: si intendono le 2 o 3 righe tra il titolo e l’inizio
dell’articolo che servono per riassumerlo nei suoi argomenti
principali e presentarlo al lettore. Contiene lo scopo, i motivi
e gli obiettivi del documento.
Argomentazione: ragionamento con lo scopo di dimostrare
una tesi/ipotesi.
http://www.dif.unige.it/epi/hp/penco/did/lez04/1lez.pdf
Font: insieme di caratteri tipografici caratterizzati e
accomunati da un certo stile grafico o intesi per svolgere una
data funzione.
http://it.wikipedia.org/wiki/Tipo_di_carattere
Granularizzare: identificare e dimensionare pezzi di
informazioni (chunk) in modo da poterli utilizzare,
personalizzare e riutilizzare.
Grazie: le particolari terminazioni alla fine dei tratti delle
lettere. Vedi voce “Font”.
Ricerca telematica: disciplina scientifica e tecnologica per
realizzare il trasferimento a distanza delle informazioni e
delle elaborazioni. http://it.wikipedia.org/wiki/Telematica
Search Engine Optimization (SEO): tecniche finalizzate a
migliorare il posizionamento nelle ricerche dei motori per
aumentare il volume di traffico di materiali nel web e dare
maggior visibilità ai propri prodotti/servizi.
http://static.googleusercontent.com/external_content/untr
usted_dlcp/www.google.com/it//webmasters/docs/search-
engine-optimization-starter-guide.pdf

Linda Finardi - linda.finardi@libero.it 30Gen11 pag. 13

Tag: parola chiave o un termine associato a un'informazione
(immagine, mappa geografica, post, video clip ...), che
descrive l'oggetto rendendo possibile la classificazione e la
ricerca di informazioni basata su parole chiave.
Tagging: applicazione delle etichette per migliorare la
ricerca delle informazioni basata su parole chiave.
Può riguardare il titolo, i sottotitoli, elementi del testo, le
immagini, l’argomento o l’autore, ma anche argomenti più
generali di cui non si parla direttamente nell’articolo.
http://it.wikipedia.org/wiki/Tag_%28metadato%29
Technical Writing (TW): tecnica di scrittura.
http://en.wikipedia.org/wiki/Technical_writing

Linda Finardi – Technical Writer.

Progetta e ristruttura documenti per una migliore
fruibilità e comunicabilità interna ed esterna nelle
organizzazioni.
Per le aziende sviluppa strumenti informativi, quali
manuali d’istruzione e guide per prodotti e servizi
industriali e tecnologici.
Per le scuole pubbliche e private sviluppa progetti e
documenti didattici inerenti strumenti web e media.
Per le associazioni di categoria e professionisti di
diversi settori, ristruttura e sviluppa presentazioni di
ricerche e progetti, relazioni, documenti gestionali.
Formatrice in technical writing per aziende,
associazioni, professionisti, studenti e docenti.
Diplomata come geometra e laureata alla magistrale
in Comunicazione, combina competenze tecniche a
conoscenze socio-umanistiche.
Specializzata nella comunicazione web.
[linda.finardi@libero.it]

Linda Finardi - linda.finardi@libero.it 30Gen11 pag. 14