Soluzioni: facciamoci...le note degli altri!

Ora vediamo come vengono usate le note nei manuali di alcuni tra i maggiori vendors del mondo ICT.
Nei suoi manuali la SUN usa una forma molto sobria per proporre la nota:

Questo stile non mi convince, se una nota è "troppo sobria" rischia di non essere... notata!
La Microsoft in alcuni manuali (ad esempio, nei manuali che si usano per preparare una certificazione), usa ben 10 tipolgie di note:


Francamente mi sembra un eccesso di zelo; tuttavia, nell'ottica di un manuale che devo usare per ottenere una certificazione, questo approccio molto differenziato può avere una valenza didattica degna d'attenzione.

HP in molti manuali utilizza una modalità meno dettagliata rispetto a quella utilizzata da Microsoft, ma comunque efficace e strutturata su 4 tipi di note distinte:

Se possiamo ravvisare un difetto, dobbiamo dire che le icone utilizzate per indicare la nota non sono molto caratterizzate dal punto di vista grafico e non colpiscono sufficentemente l'occhio.

Anche nei Redbooks della IBM potete trovare diversi tipi di note.
Di seguito ne riporto soltanto 3 a titolo di esempio:




Lo stile di IBM è anch'esso molto sobrio, tuttavia la nota, grazie allo sfondo grigio, emerge in modo molto distinto rispetto al testo.

Come potete vedere da questi esempi, ogni vendor usa uno stile diverso, ma tutti utilizzano le note "in prossimità" del contesto a cui si riferiscono, rifuggendo quindi dallo stile classico della nota a piè di pagina o dalle note di chiusura, di cui vi ho fatto cenno nel post precedente.
Potrei fare molti altri esempi, ma lo scopo di questo post non è fornire una tassonomia di tutti i modi possibili di proporre una nota.

Quello che mi interessa sottolinare è che quando scrivete un documento tecnico, dovete fare attenzione a questo aspetto: mettete sempre in primo piano gli elementi essenziali di un discorso, la linea di pensiero fondante, il percorso concettuale fondamentale che l'utente deve seguire con attenzione.
Tutti gli elementi complementari e asincroni rispetto alla linea generale, possono essere evidenziati con delle note, posizionate "in prossimità" del flusso generale.

Nei post futuri vi proporrò qualche esempio per chiarificare la questione.

Condividi

Articoli correlati per categorie