Linee guida per la redazione tecnica e l`uso dei CMS

Linee guida per la redazione
tecnica e l'uso dei CMS
tcworld Roadshow 2009
Managing multilingual contents
Milano, 19 giugno 2009
Giorgia Cazzola
Managing multilingual contents
La documentazione tecnica: scopi
Per l’utente
Trasferire le conoscenze
Istruire
Avvertire
Per l’azienda
Migliore organizzazione e strutturazione interna
Riduzione costi traduttivi
Riduzione costi after sales (supporto, legale)
Giorgia Cazzola
Linee guida per la redazione tecnica e l'uso dei CMS
1
Managing multilingual contents
Il contesto di redazione
Normativa (ISO, UNI, Direttiva 2006/42/CE)
Bassa considerazione della documentazione
Documentazione multilingue
Molteplici mezzi di pubblicazione
Ciclo di vita prodotto-documentazione
PMI
un solo redattore
gruppo di alcuni redattori
Grandi aziende
reparto di redazione in ogni sede
Giorgia Cazzola
Linee guida per la redazione tecnica e l'uso dei CMS
2
Managing multilingual contents
La qualità della documentazione
• Accessibilità (strutturazione informazioni)
• Leggibilità (testo: lessico, sintassi e formattazione)
• Comprensibilità (conoscenze e competenze)
• Facilità di aggiornamento
Alcuni accorgimenti
Regolamentare l’accesso ai documenti
Stabilire standard per la denominazione di file e cartelle
es. 05_Installazione_IT_V001
Giorgia Cazzola
Linee guida per la redazione tecnica e l'uso dei CMS
3
Managing multilingual contents
Il manuale di stile (MdS)
Insieme di regole per redigere testi
accessibili, comprensibili, leggibili
⇒
È centrato sul destinatario e contesto
⇒
Si basa su semplificazione e standardizzazione
⇒
Tiene conto del processo traduttivo
Giorgia Cazzola
Linee guida per la redazione tecnica e l'uso dei CMS
4
Managing multilingual contents
Perché un Manuale di stile?
Manuali tecnici appartengono a un genere testuale
Per:
l’attività di redazione (lingua, contenuto e layout)
il riutilizzo dei contenuti
la traduzione (full e fuzzy match)
Giorgia Cazzola
Linee guida per la redazione tecnica e l'uso dei CMS
5
Managing multilingual contents
I manuali di stile oggi esistenti
ITALIA
Linee guida interne
Scrittura amministrativa
Barbarino e Cerlesi, Technical
writing (1991)
ESTERO
Esempi:
AECMA Simplified English
Kohl, The Global English Style
Guide (2008)
...
Lesina, Il nuovo manuale di
stile (1994)
Giorgia Cazzola
Linee guida per la redazione tecnica e l'uso dei CMS
6
Managing multilingual contents
Come creare un Manuale di stile
Analisi dei destinatari
conoscenze tecniche e linguistiche
competenze
esigenze
Utenti eterogenei: livello minimo di conoscenze
Analisi del contesto d’uso del manuale
modalità di fruizione delle informazioni
Analisi degli strumenti da utilizzare
Giorgia Cazzola
Linee guida per la redazione tecnica e l'uso dei CMS
7
Managing multilingual contents
Cosa contiene un Manuale di stile
MACROTESTO
Struttura
Impaginazione
Caratteri
Uso del maiuscolo
Titoli
Immagini e didascalie
Giorgia Cazzola
MICROTESTO
Scelta del contenuto
Ordine del contenuto
Sintassi
Punteggiatura
Lessico
Linee guida per la redazione tecnica e l'uso dei CMS
8
MACROTESTO
Managing multilingual contents
La struttura
copertina
retrocopertina
versioni del manuale
sommario
tabella delle abbreviazioni
glossario
introduzione
sicurezza
diversi capitoli
Dichiarazione di conformità
Giorgia Cazzola
Linee guida per la redazione tecnica e l'uso dei CMS
9
Managing multilingual contents
L’impaginazione
Impostazione grafica standard
Strutturazione del contenuto attraverso
spaziature, rientri, riquadri
Utilizzo corretto della tabulazione
(segmentazione testi)
Utilizzare intestazioni e piè di pagina
(utili per consultazione veloce)
Giorgia Cazzola
Linee guida per la redazione tecnica e l'uso dei CMS
10
Managing multilingual contents
I caratteri
Stili del carattere
Colore
Uniformità delle scelte
Facilità di lettura
Giorgia Cazzola
Linee guida per la redazione tecnica e l'uso dei CMS
11
Managing multilingual contents
L’uso del maiuscolo
Da non usare per evidenziare termini o frasi
Giorni, mesi e anni in minuscolo
es. venerdì 19 giugno 2009
Titoli: solo la prima iniziale è in maiuscolo
es. Interventi di Manutenzione Software
Interventi di manutenzione software
Giorgia Cazzola
Linee guida per la redazione tecnica e l'uso dei CMS
12
Managing multilingual contents
I titoli
nome distinto ed univoco
contenuto che fissi l’attenzione
5 o 6 parole
in minuscolo
nessun punto finale
stessa struttura linguistica
Giorgia Cazzola
Linee guida per la redazione tecnica e l'uso dei CMS
13
Managing multilingual contents
FORMA
ESEMPIO
solo sostantivo (senza articolo)
Cambio formato
solo sostantivo (con articolo)
Il cambio formato
infinito
Cambiare formato
come + infinito + compl. ogg.
Come cambiare il formato
Come effettuare il cambio formato
Il costruttore
Figure professionali
Costruttore
Figure professionali
Manuale di installazione
Manuale d’Installazione
Manuale d’installazione
Giorgia Cazzola
Linee guida per la redazione tecnica e l'uso dei CMS
14
Managing multilingual contents
Le immagini e le didascalie
Stabilire standard di uso delle immagini
Didascalie:
distinguere tra immagine, schema, disegno...
non utilizzare avverbi e locuzioni di luogo
(a fianco, sopra...)
utilizzare forma attiva
massimo 10 parole circa
terminare con un punto
Nello schema a fianco è mostrato
un esempio di layout di una
macchina modello XXX con
evidenziate le componenti principali
L’immagine mostra il layout di una
XXX e le componenti principali.
Giorgia Cazzola
Linee guida per la redazione tecnica e l'uso dei CMS
15
MICROTESTO
Managing multilingual contents
La scelta del contenuto
Valutare il destinatario
Includere parti obbligatorie (normative)
Le informazioni devono essere:
brevi e necessarie (evitare ridondanze)
complete
significative e pertinenti
esatte e verificabili
coerenti
chiare (evitare le ambiguità)
Giorgia Cazzola
Linee guida per la redazione tecnica e l'uso dei CMS
16
Managing multilingual contents
L’ordine del contenuto
Una sola azione per paragrafo
Procedura
Ordine sequenziale
1. Messaggio di sicurezza
2. Strumenti da utilizzare
3. Fase A della procedura
4. Momento di verifica
5. Fase B della procedura
...
Giorgia Cazzola
Linee guida per la redazione tecnica e l'uso dei CMS
17
Managing multilingual contents
La sintassi
Struttura Soggetto + Verbo + Complemento
Quando si spegne il monitor è interrotto il sistema.
Quando si spegne il monitor, il sistema è interrotto.
Forma passiva
Tramite il pulsante verde, vengono aggiornati i dati.
Forma attiva
Tramite il pulsante verde, il sistema aggiorna i dati.
Tramite il pulsante verde, l’utente aggiorna i dati.
Verbo generico + sostantivo
Verbo semplice
Giorgia Cazzola
effettuare la cancellazione
cancellare
Linee guida per la redazione tecnica e l'uso dei CMS
18
Managing multilingual contents
La sintassi delle classi funzionali
Messaggi di sicurezza
congiuntivo
sintagmi nominali
indicativo
brevi frasi (elenco)
imperativo
Elenco: frase introduttiva
grammaticalmente completa
infinito
Caratteristiche tecniche
Rimandi
Comandi
modo imperativo dei verbi
(es. Apri/Aprite)
Vedi sotto/sopra, a fianco
infinito (accezione imperativa)
Frase finale all’inizio della frase
Vedi
+ nel manuale + TITOLO MANUALE
+ il paragrafo + titolo paragrafo
+ il capitolo + “TITOLO CAPITOLO”
Giorgia Cazzola
Linee guida per la redazione tecnica e l'uso dei CMS
19
Managing multilingual contents
La Punteggiatura e i numeri
Full matches
punteggiatura identica
Non usare la virgola tra soggetto e verbo
I valori di rumorosità indicati, sono livelli di emissione.
I valori di rumorosità indicati sono livelli di emissione.
Numeri decimali
Migliaia
Giorgia Cazzola
virgola (es. 10,5)
punto (es. 90.235)
Linee guida per la redazione tecnica e l'uso dei CMS
20
Managing multilingual contents
Il lessico
Preferire:
Evitare:
•
termini precisi
•
uso dei sinonimi
•
parole comuni
•
parole vuote o vaghe
(es. normale, eccessivo...)
dirette
espressioni ridondanti e
gergali
•
non ambigue
•
il sintagma con il minor
numero di parole.
Giorgia Cazzola
uso metaforico tra
virgolette
•
Linee guida per la redazione tecnica e l'uso dei CMS
21
Managing multilingual contents
Interruttori: nome esatto che compare sull’etichetta
interruttore d’accensione
Interfaccia software: usare termini localizzati
Barra principale (MAIN BAR)
Barra principale
Prefissi: senza trattino
microinterruttori
pulsante Start
micro-interruttori
Simboli e unità di misura: dopo il valore separati da
uno spazio; senza punto
220V
m. 8,5
Giorgia Cazzola
V220
220 V
8,5 m
Linee guida per la redazione tecnica e l'uso dei CMS
22
Managing multilingual contents
Il controllo stilistico dei contenuti
Glossario per standardizzazione terminologia
Controllo stilistico personalizzato (linee guida)
Scrittura di simboli e unità di misura
Controllo lunghezza frasi
Uso abbreviazioni
MA
per l’italiano
non sono disponibili
strumenti di controllo stilistico e grammaticale
Giorgia Cazzola
Linee guida per la redazione tecnica e l'uso dei CMS
23
Managing multilingual contents
I CMS e il Manuale di stile (MdS)
Alto livello di granularità del contenuto
Per ogni testo e immagine occorre individuare:
la funzione e il contenuto (criteri funzionali)
il momento in cui si colloca (sequenza)
formulazione sintattica
layout
Risultato: moduli che vengono assemblati
Giorgia Cazzola
Linee guida per la redazione tecnica e l'uso dei CMS
24
Managing multilingual contents
Esempi di criteri funzionali
Messaggio di sicurezza
Parte procedurale
1.
Avvertimento
1.
Invito all’azione 1
2.
Tipo di rischio
2.
Momento di verifica
(conferma dell’azione)
3.
Comportamento da adottare
3.
Avvertenza
4.
Condizione di partenza
della azione 2
5.
Indicazione del risultato
AVVERTENZA
Pericolo di schiacciamento delle mani
Durante la fase di carico le morse si
chiudono automaticamente per bloccare il
pezzo.
Tenere le mani lontane dalle morse.
Giorgia Cazzola
Linee guida per la redazione tecnica e l'uso dei CMS
25
Managing multilingual contents
Cosa deve contenere
il MdS per l’uso con i CMS
Visione d’insieme
VS
Visione parziale dei moduli (classi funzionali)
Gestione delle varianti (frequenza, modalità)
Granularità del contenuto (dimensioni dei moduli)
Classificazione dei metadati
Quali informazioni devono esserci in un documento
(es. status, traduzione, prodotto)
Giorgia Cazzola
Linee guida per la redazione tecnica e l'uso dei CMS
26
Managing multilingual contents
Un esempio di applicazione
di CMS e MdS
Nel Manuale di stile:
Messaggio di sicurezza
parola di segnalazione maiuscolo + grassetto
titolo grassetto
testo tondo
non utilizzare il punto esclamativo né i due punti
non utilizzare le abbreviazioni
massimo 3 frasi per ciascun messaggio
massimo 5 parole per ciascuna frase
Giorgia Cazzola
Linee guida per la redazione tecnica e l'uso dei CMS
27
Managing multilingual contents
Il sistema CMS assembla i moduli:
1.
2.
3.
4.
5.
6.
grafica di segnalazione
parola di segnalazione (maiuscolo + grassetto)
titolo grassetto
tipi e fonti di pericolo
testo tondo; verbo all’infinito
misure di sicurezza
ATTENZIONE
Risultato
Giorgia Cazzola
Pericolo di ustioni
Prima di procedere alla manutenzione
della centralina servizi attendere il
raffreddamento delle parti soggette a
forte riscaldamento
Linee guida per la redazione tecnica e l'uso dei CMS
28
Managing multilingual contents
In sintesi
Sistema di redazione attuale
Manuale di stile standardizzato
Archiviazione del materiale
Eventuale scelta di un CMS
(costi, implementazione in parallelo a sistema tradizionale...)
Integrazione CMS e Manuale di stile
Giorgia Cazzola
Linee guida per la redazione tecnica e l'uso dei CMS
29
Managing multilingual contents
Thank you!
Please contact me:
Giorgia Cazzola
[email protected]
All rights reserved by Giorgia Cazzola
Giorgia Cazzola
Linee guida per la redazione tecnica e l'uso dei CMS
30