La Qualità della documentazione tecnica: Chiarezza e Sintesi

Iniziamo questo percorso alla ricerca della Qualità della documentazione tecnica, secondo uno schema ispirato al principio del "learning by doing", partendo da osservazioni concrete e cercando di desumere, da queste, dei principi di ordine generale... se possibile!

Quando decidiamo di leggere un romanzo per passione e per diletto, è spesso molto gratificante abbandonarsi nei labirinti concettuali che l'autore ci propone, seguendo il filo di una costruzione intrigante e ricca di enigmi e sorprese.

Quando invece leggiamo un documento tecnico, lo facciamo per motivi professionali.
Cerchiamo in esso informazioni che ci servono per il nostro lavoro, per risolvere problemi concreti (installare un software, montare un armadio, configurare le funzionalità del nostro nuovo televisore al plasma,...), disponendo di tempi generalmente sempre molto compressi.

Quindi cosa c'è di più desiderabile di un documento incentrato sulla CHIAREZZA e sulla SINTESI?

In effetti è proprio quello che vogliamo: trovare tutte le informazioni che ci necessitano espresse chiaramente, senza omissioni e senza inutili giri di parole. C'è qualcuno di voi che ha il coraggio di alzare la mano e contestrmi? Chi di voi vuole leggere un documento OSCURO e PROLISSO? Quindi sto sostenendo un'ovvietà! Siete proprio sicuri?

Ora mi viene in mente che avrei potuto scivere "senza inutili circonlocuzioni".
Secondo me "CIRCONLOCUZIONI" è molto meno di chiaro di "GIRI DI PAROLE".
Però è più sintetico, è una sola parola, mentre "GIRI DI PAROLE" sono 3 parole!

Il problema è proprio questo: generalmente CHIAREZZA e SINTESI sono due proprietà in contrasto.
UN esempio? Eccolo:

FRASE 1
"MyNet Manager è un prodotto finalizzato alla gestione ottimizzata di una LAN (Local Area Network). Attraverso la Web COnsole di Amministrazione di MyNet Manager, è possibile configurare facilmente numerosi parametri per l'analisi e la gestione della vostra rete. MyNet Manager vi mette a disposizione un largo set di opzioni finalizzate ad individuare e tracciare tutte le informazioni che caratterizzano la dinamica funzionale della vostra rete"

E' chiaro? Non ne sono certo. E' sintetico? No!
Che cosa avete capito? Troppi aggettivi? Temo di si.
Riscriviamolo:

FRASE 2
"MyNet Manager è una Administration Web Console che vi permette di monitorare un largo set di caratteristiche della vostra LAN (Local Area Network), configurando facilmente un gran numero di parametri necessari a tale scopo".

Questa versione mi piace, mi sembra abbastanza chiara e più sintetica.
La volete più sintetica?

FRASE 3
"MyNet Manager vi permette di monitorare un largo set di caratteristiche della vostra rete locale".

Mi sembra ancora sufficentemente chiara e super sintetica.
Più di così non è possibile... o si?

FRASE 4
"MyNet Manager controlla la rete locale".
La rete di che? Di chi? In che senso la controlla? Come?
No, qui non ci siamo, abbiamo ottenuto una sintesi esagerata ma la chiarezza è scomparsa.

Se volessimo avere una rappresentazione grafica qualitativa della relazione che lega CHIAREZZA e SINTESI, potremmo disegnare un grafico di questo tipo:


Ad ogni FRASE k corrisponde una coppia di coordinate (SFk,CFk) che corrispondono ai valori di SINTESI e CHIAREZZA della frase in esame.
Come si osserva facilmente, quando la sintesi è elevata (SF4), la chiarezza tende a 0 (CF4). Se la sintesi invece tende a 0 (SF1), la chiarezza tende ad essere più elevata (CF1).
Esiste poi una coppia di valori (SF,CF), indicata in BLU, che ci consente di massimizzare la chiarezza, accettando un livello di sintesi non troppo elevato. Aumentando il valore della sintesi si arriva ad individuare una zona del grafico caratterizzata da un rettangolo azzurro che forse rappresenta la zona di miglior equilibrio tra i valori combinati di questi attributi.

In effetti, sia la FRASE 2 (SF2,CF2) che la FRASE 3 (SF3,CF3) possono essere considerate accettabili. Il grafico ovviamente è solo un modo di visualizzare l'andamento qualitativo che lega questi due concetti, un ausilio a supporto della mia tesi. La cosa che mi interssa veramente è sottolineare che CHIAREZZA e SINTESI sono ingredienti necessari e contrastanti, che devono essere armonizzati quanto più possibile e che possono rappresentare la prima tessera del puzzle della Qualità che stiamo tentando di ricostruire.

Condividi

Articoli correlati per categorie