Soluzioni: l'uso delle immagini

L'uso delle immagini svolge un ruolo fondamentale nella semplificazione dei concetti che devono essere trasmessi in un documento tecnico. Grafici di vario tipo (cartesiani, istogrammi, a torta, puntiformi, ...), schemi e qualsiasi altro tipo di immagine in grado di supportare il testo, rappresentano un ausilio prezioso.

Volete un esempio? L'immagine seguente illustra il comportamento di un agent software che valuta la raggiungibilità di una pagina Web e analizza le diverse opzioni che possono verificarsi:


L'immagine è estremamente auto-esplicativa, spiega chiaramente la logica di analisi dell'agent e non richiede null'altro che una breve introduzione, del tutto analoga a quella che ho usato poco prima.

MA ORA ELIMINIAMO L'IMMAGINE... e spieghiamo come funziona l'agent!

Cosa verrà fuori?

Una cosa di questo genere:

"... l'agent, in primo luogo, cerca di raggiungere il Web Server. Se non ci riesce, lancia un allarme di "WEB SERVER NON RAGGUNGIBILE". Altrimenti, verifica che il protocollo HTTP sia attivo. In caso negativo, lancia un allarme "PROTOCOLLO HTTP DOWN". Se invece il protocollo è attivo, l'agent verificherà se la pagina Web richiesta è corretta. In caso positivo, l'analisi dell'agent è terminata. Altrimenti, analizza se l'RDBMS è raggiungibile. In caso negativo, lancia un allarme "RDBMS DOWN". Altrimenti..."

Mi sembra evidente come, in assenza dell'immagine, la descrizione testuale risulti estremamente ostica e, nella migliore della ipotesi, costringerà il lettore a ri-disegnare l'albero che descrive la dinamica di funzionamento dell'agent, cioè ricostruire l'immagine mancante.

In tal caso, STIAMO COSTRINGENDO IL LETTORE A FARE IL LAVORO CHE AVREMMO DOVUTO FARE NOI, cioè SEMPLIFICARE LA STRUTTURA DELLA COMUNICAZIONE.

Non siete abbastanza convinti?

Allora immaginiamo che esista un prodotto software che si chama MY_NET Scheduler e che, nella sua scheda tecnica, si debba illustrare la struttura stratificata del prodotto, imperniata su diversi moduli componenti. Ecco la figura che illustra tale struttura:


Vi assicuro che anche con l'ausilio di questa immagine, fornire una descrizione chiara e sintetica dei diversi moduli e della loro mutua interazione non è affatto banale, ma senza di essa sarebbe oltremodo più complicato.

Con questo primo post spero di aver introdotto il tema dell'importanza delle immagini nella comunicazione tecnica. Seguiranno altri esempi sull'argomento.
Ciao.

Condividi

Articoli correlati per categorie