L’arte del riordino… dei contenuti

6 Aprile 2022

Quando si parla di riordino il nome che sicuramente si impone su tutti è quello di Marie Kondo, esperta di organizzazione e autrice del bestseller di fama interplanetaria del libro Il magico potere del riordino: il metodo giapponese che trasforma i vostri spazi e la vostra vita.

Ordine e riordino sono un argomento di conversazione pressoché giornaliero qui in Editha, ma a differenza del metodo Kondo, conservare solo quello che ci dà gioia non è un criterio applicabile quando ci troviamo davanti a un lavoro di organizzazione o riorganizzazione di documentazione tecnica.

Tutti ne abbiamo uno: un cassetto in cucina pieno di “roba varia”. Nessuno sa come sia possibile che lì dentro ci siano finite batterie scariche e pacchetti di salsa di soia scadute, ma ormai solo l’idea di riorganizzarne il contenuto per mettere tutto al suo legittimo posto è sufficiente per farcelo richiudere con una mossa ben assestata del bacino.

Abbiamo visto che spesso la stessa cosa accade per il corpo della documentazione aziendale: ci sono ormai talmente tanti contenuti, tra copie di copie di revisioni che differiscono solo per una o due parole qui e lì e documenti sparpagliati in almeno tre software diversi che riorganizzare la propria documentazione sembra un task da lasciare in eredità a chi ci succederà, che senza dubbio lo lascerà aperto dopo aver creato qualche altra copia di backup.

Da dove iniziare?

Ogni cosa al suo posto e un posto per ogni cosa. 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. Da dove si può iniziare?

Secondo il nostro metodo di lavoro la maniera più efficiente di organizzare le informazioni è dividerle in topic separati, unità di senso compiuto che non dipendano da altri blocchi di testo separati. È anche importante utilizzare la stessa struttura per questi topic, per esempio ogni sezione introduttiva dovrebbe contenere sempre la stessa sequenza di informazioni, in modo che l’utente finale sappia cosa aspettarsi e come leggere tutte le sezioni del documento.

A proposito di sequenze: se i contenuti includono delle attività da svolgere in un certo ordine è importante che siano disposti in ordine cronologico, senza dare per inteso che un’azione debba essere già stata compiuta all’avvio di un’altra.

Quando poi i topic saranno posizionati uno dopo l’altro per creare il documento finale, la struttura del testo dovrebbe riportare la gerarchia delle informazioni in modo chiaro: è necessario dare enfasi alle informazioni principali e solo successivamente inserire le informazioni secondarie.

Anche l’occhio vuole la sua parte?

Parlando di accessibilità della documentazione tecnica, ci siamo già concentrati sul fatto che non tutti i testi vengono letti dall’occhio umano, e bisogna quindi tenere in considerazione gli screen reader quando ci approcciamo alla redazione e all’impaginazione dei testi, ma questo non significa privare i testi di un’organizzazione anche visiva.

Tabelle, immagini, font, titoli, stili e colori non devono essere belli (ma non esageriamo, WordArt e ClipArt lasciamole nel passato) ma prima di tutto funzionali. È bene tenere sempre a mente che i vezzi artistici e le decorazioni fine a se stesse non forniscono valore al documento tecnico, e devono quindi lasciare lo spazio a un’impaginazione che sia piacevole alla lettura ma che non intralci la comprensione del testo o aggiunga difficoltà nell’esecuzione delle istruzioni della documentazione.

La scelta delle grafiche deve essere a ogni modo coerente con la documentazione, senza utilizzare immagini che siano puramente decorative, o che non aggiungono informazioni al testo.

Icone e simboli devono essere utilizzati in maniera coerente, utilizzando sempre lo stesso simbolo e lo stesso colore per il relativo tipo di informazione da mostrare, nel rispetto delle normative internazionali vigenti per un uso sicuro, efficiente ed efficace.

Dove l’ho messo?

Al centro della riorganizzazione dei contenuti c’è la possibilità di riutilizzare i contenuti esistenti per aumentare l’uniformità e non creare documenti duplicati. Dopo aver messo in ordine i contenuti è importante avere un sistema preciso di ricerca e indicizzazione che faccia sì che il caos non si riproponga.

È importante quindi che la documentazione sia organizzata in una struttura cercabile, con un indice in caso di documentazione stampata e la possibilità di navigare facilmente i supporti multimediali o online.

L’indice deve essere completo e uniforme: è importante pensare a come la struttura dei topic del manuale si riflette nella ricerca da parte del cliente. Per esempio, mentre “accensione spie errore” può essere significativo come titolo, è più probabile che l’utente finale non pensi in termini di frasi complete di verbi, e cercherà direttamente la sezione “Spie”.

I riferimenti interni al documento (rimandi a capitoli o link e cross-reference nel caso di documentazione multimediale) sono fondamentali per far sì che l’utente si possa districare nella mole delle informazioni.

Anche le grafiche, che spesso sono dimenticate nel mare dei testi, andrebbero nominate o provviste di didascalia, in modo che siano ricercabili all’interno del documento di testo.

Organizzare la documentazione in una maniera chiara, per topic, serve sia al redattore che all’utente finale. Il redattore può controllare di non aver tralasciato nulla di importante e di aver impostato un documento che rispetta i requisiti di usabilità e leggibilità, e l’utente finale potrà usufruirne in maniera semplice.

Alla ricerca della gioia

Se leggendo questo post hai pensato immediatamente al tuo cassetto della vergogna, se i tuoi libretti, manuali, istruzioni ormai non ti danno più gioia potrebbe essere arrivato il momento di trasformare la tua documentazione, riordinandone i contenuti. Possiamo seguirti passo passo in questa attività, partendo dall’analisi dei testi esistenti e proponendoti il software o il CCMS giusto per la tua azienda, basta mandarci una mail.


© Editha S.r.l. – Questo è un post originale scritto da Editha S.r.l. che ne detiene il copyright. Riproduzione riservata.

Scritto da Sabrina Fiorini

Sabrina Fiorini è la CEO e Project Coordinator di Editha. Con quasi 30 anni di esperienza nel campo del Desktop Publishing, ha fondato Editha creando una rete internazionale di professionisti del settore per offrire un'offerta completa ad agenzie di traduzione e dipartimenti di redazione tecnica. Ama l'apprendimento continuo ed è appassionata di diete che legge assiduamente sorseggiando un calice di buon vino rosso.
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.

0 commenti

Invia un commento

Il tuo indirizzo email non sarà pubblicato.