Documentazione Strutturata – Forma e contenuto sono due binari paralleli

Documentazione Strutturata – Forma e contenuto sono due binari paralleli

Railroad Track to refer to structured documentation
Railroad Tracks

Quando si approccia un progetto di comunicazione tecnica insieme a persone che ancora non conoscono il concetto di documentazione strutturata, ci si sofferma da subito a parlare di grafica. Viene interpellato l’ufficio marketing per dare il benestare sulla dimensione dei caratteri, sui loghi, sui font, sui colori e su altri aspetti. 

Questi argomenti sono assolutamente superflui; è come se il reparto Engineering di un’azienda produttrice di automobili si soffermi a parlare del colore degli interni e del layout dei cerchioni prima di aver definito la potenza del motore, il settore di mercato o il target di riferimento. 

Questo succede perché chi non conosce il concetto di documentazione strutturata è abituato a lavorare con software di editing come Word o Indesign, dove la gestione della parte grafica modifica il modo in cui un documento deve essere pubblicato. 

Gestire la parte grafica, in fase di redazione, diventa un limite enorme quando si devono pubblicare contenuti multicanale e quando la stessa informazione deve essere riutilizzata in più punti. Inoltre, possono sempre manifestarsi problemi in fase di traduzione (per approfondimenti vi consiglio la lettura di questo articolo). 

La gestione di una documentazione strutturata svincola la parte grafica dal contenuto e permettena chi la crea di concentrarsi su cosa deve essere scritto piuttosto che a come deve essere visualizzato. 

Una documentazione strutturata, che utilizza dei parametri definiti a priori, permette di identificare un’informazione grazie ad un “tag” che può essere un titolo, un’immagine, un paragrafo o un codice. Una volta associato un “tag” ad un contenuto, questo può essere visualizzato in maniera diversa, a seconda delle necessità (ad esempio, il supporto come smartphone, laptop, carta stampata oppure un target diverso). 

Un grande vantaggio è anche sul lato grafico in quanto gestire un contenuto strutturato porta a definire degli standard di layout per un’impaginazione automatica. Si eliminano, dunque, gli errori causati dal dover gestire un’impaginazione diversa per ogni lingua; questi errori sono dovuti alla lunghezza diversa delle parole o ad una impaginazione invertita, come nel caso della lingua araba, o ad aggiustamenti per far stare il contenuto all’interno dei margini del foglio.  

Dunque, il limite più grande per effettuare questo passaggio non è tecnico, ma soprattutto mentale.