L’accessibilità della documentazione tecnica

7 Settembre 2021

La nostra filosofia per la redazione tecnica è quella di creare una documentazione chiara che non generi fraintendimenti, per redigere istruzioni semplificate e di facile comprensione.

Il contenuto della documentazione tecnica non è l’unico aspetto da tenere in considerazione quando si parla di documentazione chiara e di facile comprensione, perché questo non include il discorso dell’accessibilità di una documentazione tecnica destinata a tutti gli utenti.  Non possiamo infatti dimenticare che non tutti usufruiscono dei documenti con gli stessi strumenti, e i redattori tecnici hanno la responsabilità di tenere in mente lo spettro più ampio possibile di pubblico nella fase di redazione.

Di seguito abbiamo raccolto alcune raccomandazioni per la redazione che abbiamo incluso nelle nostre checklist di redazione per rendere i nostri testi più accessibili.

Tabelle e immagini

Tabelle e immagini sono elementi che vengono percepiti come visuali, ma sono parti fondamentali della struttura dei documenti. È determinante quindi inserirli nella documentazione tecnica in maniera ottimizzata e accessibile.

Testo

Gli screen reader non sono in grado di leggere il testo inserito nelle immagini come parte della grafica. Per questa ragione è fondamentale non inserire parti di testo in immagini, foto e grafiche (questa è inoltre un’ottima pratica per quanto riguarda i processi di traduzione, in quanto anche i CAT Tool non sono in grado di riconoscere il testo nelle immagini e quindi prepararlo per la traduzione). 

Alt text

Immagini e tabelle prevedono invece la proprietà alt text. Si tratta di un testo che può essere correttamente letto dagli screen reader per descrivere immagini e tabelle. Questo testo non dovrebbe limitarsi a descrivere l’aspetto degli elementi grafici ma anche il loro intento.

Per la documentazione online, l’alt text è un elemento che aiuta a indicizzare le immagini correttamente ed è inoltre un elemento che può essere visualizzato anche in caso di mancato o errato caricamento degli elementi che descrivono.

Allineamento

Lo scorrimento degli screen reader, così come quello naturale del nostro sguardo, è quello di muoversi come un cursore, dall’alto verso il basso e da sinistra verso destra. Immagini e tabelle devono quindi essere allineate a sinistra del testo. Altri tipi di allineamento possono “spezzare” le frasi lette dagli screen reader facendo perdere il senso del testo scritto.

Celle unite e intestazioni

Unire le celle delle tabelle è una pratica molto diffusa per aumentarne l’estetica. Gli screen reader però non sono in grado di leggerle correttamente e di identificarne l’intento, quindi è buona pratica non usare celle unite per rendere la documentazione accessibile. 

La riga di intestazione della tabella dovrebbe essere impostata come ripetibile a ogni nuova pagina, così il testo sarà più facilmente interpretabile in caso di tabelle che spaziano su più pagine.

Formattazione di testo e documenti

Anche la formattazione non è semplicemente una questione estetica, ma serve a identificare correttamente le parti del documento scritto. Una buona pratica è quella di usare elementi come grassetto, corsivo e sottolineato in maniera uniforme in tutto il documento e usare le relative funzioni per creare liste puntate e numerate senza usare caratteri di testo decorativi.

Se previsto dal software è anche importante impostare correttamente la lingua del documento.

Titoli e intestazioni

Titoli e intestazioni non sono semplicemente un vezzo grafico che ha come unico risultato quello di ingrandire il font in quella parte di documento. Gli screen reader e i sintetizzatori vocali di testo riconoscono i metadati che questi elementi creano per leggere e rendere correttamente il testo. 

Da un punto di vista della formattazione in generale, titoli e intestazioni devono essere ben visibili e spaziati, in modo da creare una netta differenza con il resto del testo dei paragrafi. Dovrebbe essere quindi ben leggibile a occhio nudo (sopra gli 11 pt) e allineato a sinistra.

Colori

L’accessibilità della documentazione tecnica passa anche dalla scelta dei colori in fase di redazione. Bisogna tenere a mente che la percezione dei colori degli utenti può variare drasticamente, è quindi importante impostare la documentazione in modo che i colori diano il maggior contrasto possibile tra contenuto e sfondo, in modo che testo ed elementi grafici siano ben leggibili da chiunque.

È anche importante tenere in considerazione i colori che più comunemente non vengono percepiti a causa di difetti alla vista, come verde e rosso: bisogna evitare di usare questi colori nei testi come indicatori per fattori “positivi” e “negativi”.


Lo scopo di un documento efficace è quello di essere compreso senza fraintendimenti: l’accessibilità della documentazione tecnica è alla base del nostro processo di redazione tecnica per testi davvero user-friendly.

Scritto da Stefano Vallini

Stefano Vallini è co-founder di Editha; partecipa da subito, prima molto silenziosamente ma costantemente, poi col rumore che si addice alla sua mole, alla gestione dell’azienda. Le sue esperienze trentennali in ambito tecnico, giuridico, commerciale, ne fanno un personaggio eclettico che sa un po’ di tutto senza sapere nulla nello specifico. È in azienda la figura che tuttavia unisce i punti, come il gioco della settimana enigmistica, rende coesa una squadra. Strimpella ostinatamente da tutta la vita la chitarra sognando di essere David Gilmour, poi… si sveglia.
Il futuro presente dei training

Il futuro presente dei training

Da diverso tempo ormai Editha collabora con clienti che utilizzano strumenti innovativi come Synthesia e Vyond per la realizzazione dei loro video. Queste piattaforme permettono di realizzare video in pochi minuti grazie all’uso dell’Intelligenza Artificiale.

Documentazione tecnica e sostenibilità

Documentazione tecnica e sostenibilità

Tra i punti oggetto di discussione nella bozza del nuovo Regolamento Macchine troviamo anche la proposta, diretta al fabbricante, di realizzare l’intera documentazione che accompagna la macchina esclusivamente in formato digitale. È possibile avviarsi verso una digitalizzazione anche solo parziale della documentazione tecnica? È quello che i tecnici attualmente al lavoro sulla nuova proposta di Regolamento Macchine si stanno chiedendo. Questo articolo analizza criticità e vantaggi di questa digitalizzazione.

L’arte del riordino… dei contenuti

L’arte del riordino… dei contenuti

La questione fondamentale nel processo di riordino dei contenuti all’interno di un documento è disporli in maniera coerente in modo che si possano poi trovare, aggiornare e usare facilmente nella creazione dei contenuti. Secondo il nostro metodo di lavoro la maniera più efficiente di organizzare le informazioni è dividerle in topic separati, disposti in ordine cronologico e gerarchico. È importante, inoltre, che la documentazione sia organizzata in una struttura cercabile.

0 commenti

Invia un commento

Il tuo indirizzo email non sarà pubblicato.