Soluzioni: uso degli elenchi.

Una delle situazioni più tipiche che mi è capitato di riscontrare nei documenti tecnici scritti in modo poco accorto, consiste nello scarso utilizzo degli elenchi (puntati e/o numerati) laddove sarebbero utili e necessari.
Consideriamo l'esempio seguente:

"...attraverso la console degli eventi è possibile controllare l'utente che ha effettuato una certa operazione, l'ora in cui è stata effettuata, il suo ruolo operativo registrato nel sistema, il dispositivo sui cui è stata effettuata, l'insieme degli eventi che sono stati scatenati dall'operazione, i dati coinvolti, le eventuali notifiche configurate..."

Che cosa abbiamo appena letto?
Niente di complicato... un semplice "elenco".

Un elenco di concetti, esattamente un elenco delle funzionalità accessibili attraverso una fantomatica "console degli eventi".
E allora perchè non lo scriviamo IN FORMA DI ELENCO ?

"...attraverso la console degli eventi è possibile controllare:

• l'utente che ha effettuato una certa operazione;
• l'ora in cui è stata effettuata;
• il suo ruolo operativo registrato nel sistema;
• il dispositivo sui cui è stata effettuata;
• l'insieme degli eventi che sono stati scatenati dall'operazione
• i dati coinvolti;
• le eventuali notifiche configurate.

..."

La differenza non è trascurabile.

Presentare in maniera banalmente descrittiva un set d'informazioni che, strutturalmente, identificano un elenco, costringe il lettore a ricostruire, nella sua testa, la struttura dell'elenco, inducendolo ad un inutile esercizio che lo distrae dal nocciolo della comunicazione.

Non è l'esempio più cattivo che potevo fare... ho visto elenchi di concetti/oggetti che si dipanavano su una dozzina di righe... in genere già alla sesta riga l'attenzione del lettore viene messa a dura prova.

Ma a questo punto dobbiamo fare un ulteriore distinzione tra "elenchi puntati" ed "elenchi numerati".
Nell'esempio precedente abbiamo usato un elenco puntato, perchè le informazioni presentate costituiscono "un insieme non ordinato"; che significa ?
Significa che modificare la posizione di uno più items dell'elenco, non modifica il contenuto della comunicazione.

Ma ora consideriamo un'altro esempio:

"...

1. Selezionare l’evento in errore più antico tra quelli prodotti.
2. Ricostruire la causa dell’errore in base agli indizi disponibili.
3. Sanare l’evento in base a quanto ricostruito.
4. Riavviare il Motore degli Eventi al fine di rielaborare l’evento.
5. Se l’evento va ancora in errore, è necessario ritornare al punto 2.

..."

E' evidente che, in questo caso, modificando l'ordine dei concetti, verrebbe meno il senso della comunicazione.

L'elenco numerato DEVE ESSERE SEMPRE utilizzato quando tra un insieme di oggetti/concetti esiste una relazione di ordinamento
che determina la semantica dell'elenco.

Condividi

Articoli correlati per categorie