Chi trova un template... trova un tesoro!

Dopo aver stabilito quali/quanti documenti devono accompagnare il nostro prodotto, ci troviamo davanti alla prima pagina bianca del primo manuale.
E' un evento inevitabile e il "panico da foglio bianco" è una sensazione ben nota, che tutti noi abbiamo provato almeno una volta nella vita.
Esistono diverse tecniche per esorcizzarlo e di certo sarebbe utile disporre di un "template", cioè di un modello che, fin dall'inizio, ci aiutasse a delimitare la forma e la struttura dei contenuti che dobbiamo articolare.

PERCHE' USARE UN TEMPLATE?

In primo luogo, semplicemente perchè consente di risparmiare una gran quantità di tempo che, come ben noto, è denaro.

In secondo luogo, perchè l'omogeneità stilistica è uno dei principali parametri per identificare la qualità di un documento.

Non ci credete? Provate a scaricare, dal sito istituzionale della IBM, due o tre Redbooks.
Apriteli in sequenza, uno dopo l'altro, saltellando a caso fra i contenuti. Non è necessario essere un esperto di informatica, anzi non è necessario nemmeno capire cosa state leggendo, per "avvertire" la qualità di questi documenti. La loro sobria ed efficente solidità stilistica, di per se stessa, vi trasmetterà istantaneamente la sensazione di un oggetto "ben realizzato" e questo è importante.

In tal senso, un insieme ben definito di template permette di realizzare un insieme di documenti che contribuiscono al brand della vostra azienda. Cosa c'è di peggio che inviare al cliente di turno un set di manuali con un "look and feel" non omogeneo, disordinato e privo di un stile riconoscibile come quello "proprio" dell'azienda ?

A differenza della documentazione di marketing, che deve colpire la fantasia del cliente, sollecitandolo con meccanismi anche aggressivi o sorprendenti, ben noti agli esperti di pubblicità, la documentazione tecnica deve essere "rassicurante" e facile da usare; se vi abituate ad utilizzare dei template ben strutturati, potrete raggiungere questo obiettivo più agevolmente.

Un template può contenere diversi elementi, alcuni dei quali sono elencati di seguito:

- lo stile e la struttura della copertina (front cover)
- lo stile dell'indice generale del documento
- gli stili dei paragrafi usati nel documento
- i livelli di profondità dei titoli e dei paragrafi
- il layout di ogni elemento di ogni pagina
- lo stile dell'header e del footer
- lo stile dele tabelle
- lo stile delle note
- lo stile e la struttura del glossario
- lo stile e la struttura della bibliografia
- lo stile e la struttura della quarta di copertina (back cover)
- altro ancora...

E' impensabile, per ogni documento di ogni prodotto, ridefinire ogni volta da zero tutti questi elementi che possono esser strutturati solo a valle di un gran lavoro di progettazione e design, quasi sempre attraverso raffinamenti successivi, che richedono tempo ed esperienza.
Nell'azienda in cui lavoro, ho impiegato circa 3 anni per mettere a punto, per approssimazioni progressive, un certo numero di template efficaci e ritengo di dover ancora migliorarne alcuni aspetti, senza considerare tutti i template che devo ancora mettere a punto.

Un template ben fatto può essere riutilizzabile da writers diversi, che non dovranno preoccuparsi di definire la struttura del documento ma potranno focalizzarsi solo sui contenuti.

Un template consente di ridurre gli errori.
Ad esempio, la versione di un prodotto viene di solito riportata nel titolo del manuale, nella quarta di copertina e nel footer di ogni pagina. Legando questi elementi con un "campo dinamico", sarà possibile apportare le necessarie modifiche in ogni punto del documento, semplicemente modifcando tale campo; un writer poco accorto invece, si metterebbe a modificare "a mano" questa informazione in tutti i punti del documento in cui essa compare, con un notevole dispendio di tempo e rischiando quasi certamente di non riuscire ad aggiornare correttamente tutti i riferimenti presenti.

Insomma, non c'è veramente nessun buon motivo per non usare un template.
Il tempo che inizialmente dovrete investire per costruire un buon template, lo riguadagnerete cento volte in seguito.

In futuro, nella sezione Templates, troverete la descrizione della struttura di diversi template, ognuno con le sue peculiarità, che poi potrete liberamente scaricare da Scribd, uno dei più noti servizi per condividere documentazione.

Condividi

Articoli correlati per categorie