Aggiungiamo le tabelle al nostro Template

Nel post del 7 Novembre 2009 vi avevo messo a disposizione un primo basic Template "general purpose", liberamente scaricabile via SCRIBD.
Ora aggungiamo qualche elemento.
Può essere molto utile disporre di un set di tabelle da utilizzare nei nostri documenti. Inoltre, può essere comodo anche avere un indice(sommario) che ci permette di rintracciare rapidamente tutte le tabelle che abbiamo disseminato nel nostro documento. In questo nuovo Template, nel Capitolo 3, trovate 3 tabelle rispettivamente a 2, 3 e 4 colonne:


Possono essere selezionate e quindi copiate e incollate in ogni punto del documento.
La didascalia posta alla base della tabella viene indicizzata attraverso l’indice delle tabelle, posizionato in fondo al Template. La numerazione è automatica ed è strutturata semplicemente così:

Tabella NUMERO CAPITOLO.NUMERO TABELLA - Didascalia

Per aggiornare la numerazione, basta selezionare il numero X.Y, quindi premere il pulsante destro del mouse; nel menù a tendina che viene visualizzato, selezionate Aggiorna campo.

Per analizzare le proprietà delle tabelle proposte, basta selezionare la tabella quindi premere il pulsante destro del mouse; nel menù a tendina che viene visualizzato, selezionate Proprietà tabella.


L'indice(sommario) delle tabelle ha una natura del tutto analoga a quella dell'indice generale del Template e si aggiorna con la modalità già illustrata nel post sopracitato.
Provate a scaricare questo secondo Template e ad utilizzarlo. Leggi questo articolo...

Scrivere per il Web... non è solo una questione di font.

Il mio collega Daniele mi ha segnalato un link molto interessante, che vi propongo a mia volta.
Quando si scrive per il Web spesso si pensa, erroneamente, che si debbano applicare le stesse regole tipografiche che si applicano nella scrittura classica in ambiti più tradizionali (libri, riviste, quotidiani, ...). In realtà, la scrittura per il Web è un'attività molto più ricca e consente soluzioni molto più potenti e complesse.
Proprio per questo è necessario assorbire e strutturare una competenza specifica, perchè non è detto che chi ha imparato a scrivere, anche professionalmente, in un ambito tradizionale, sappia poi essere parimenti efficace sul Web.
Gli spunti proposti da Mark Boulton sono sicuramente interessanti.
Come dico sempre, studiate, saccheggiate e "copiate" da quelli più bravi di voi... solo poi sarete in grado di impiantare soluzioni "vostre" ed originali.
Spero possa esservi utile. Leggi questo articolo...

Lettera d'Incarico: un primo Template

Nel post di ieri ho parlato della Lettera d'Incarico e ho fornito un semplice modello della medesima.
Come sempre, tale esempio non è certamente esaustivo di tutte la casistiche in cui può essere utile saper scrivere una lettera di questo tipo. Potete ora anche scaricare un Template congruente a quanto indicato nel post. Presto tornerò sull'argomento con un altro esempio e annesso Template.
Fatemi avere eventuali osservazioni che riterrete opportune, anche sull'efficenza di SCRIBD. A presto. Leggi questo articolo...

Saper scrivere... la Lettera d'Incarico: un primo esempio

La "Lettera d'Incarico" è un classico della scrittura tecnico-commerciale.
Non è possibile individuare un solo modello general purpose per questa composizone.
Ci sono soluzioni adatte per definire i rapporti professionali che si vengono a stabilire tra due privati o tra un'azienda e un suo impiegato.
La struttura e i contenuti cambiano anche in base all'ambito professionale specifico, perche' possono mutare le normative e gli obblighi che devono essere specificati nella lettera.

In un'azienda, quando ad una persona viene assegnata una nuova posizione professionale, è d'uso ufficializzare tale evento con la Lettera d'Incarico.

Essa deve contenere alcuni elementi obbligatori, che sono:

• il nome dell'azienda, la sede e la data in cui la lettera è stata redatta (generalmente in alto a destra);

• il nome della persona che riceve l'incarico (sempre in alto a destra, sotto la sede e la data);

• l'oggetto, che apre la lettera, in cui viene specificato l'incarico;

• il nome dell'azienda e del Responsabile del settore/area/divisione che assegna l'incarico (generalmente in basso a destra);

• il nome e la firma dell'incaricato (generalmente in basso a sinistra).

Altri elementi importanti sono di solito confinati nel corpo della lettera e identificano:

• gli eventuali riferimenti normativi relativi all'incarico;

• l'elenco delle principali caratteristiche dell'incarico.

In effetti, l'elenco delle caratteristiche dell'incarico costituisce la parte più qualificante della lettera. E' infatti in questa parte che si definiscono i compiti che il candidato designato andrà a ricoprire. Questa parte deve essere redatta con particolare attenzione, anche in relazione ai riferimenti normativi che contribuiscono a definire il profilo dell'incarico.

Di solito,la lettera si chiude sempre con una formula di questo tipo:

"Le ricordiamo inoltre l’obbligo di riservatezza e mantenimento del segreto in ordine ai processi lavorativi di cui verrà a conoscenza nell’esercizio delle funzioni svolte."

... che sottolinea l'obbligo alla lealtà e alla riservatezza che qualsiasi impiegato deve sempre rispettare nell'ambito della sua professione.

Di seguito, vi propongo un esempio:

Questa è la prima parte, in cui c'è proprio l'elenco delle caratteristiche principali dell'incarico di RSPPA (Responsabile Servizio Prevenzione e Protezione Aziendale).

Questa è la seconda parte, in cui, in calce, è prevista la firma del Responsabile e quella dell'incaricato. La lettera deve essere ovviamente realizzata su carta intestata dell'azienda che conferisce l'incarico. Generalmente non viene spedita, ma consegnata a mano, in busta chusa.

L'esempio che vi ho proposto è estremamente semplice ma rappresenta un buon modello di partenza per orientarsi sull'argomento.
Ritornerò sulla questione prossimamente.
Leggi questo articolo...

Un primo semplice Template

Questo primo post inaugura una nuova sezione, in cui vi proporrò una collezione di template che spero possano fornirvi alcuni spunti utili per arrivare a definire I VOSTRI template. Li potrete visionare e scaricare via SCRIBD, uno tra i maggiori servizi per la condivisione di documentazione sul Web.

Questo è un esempio di basic/general purpose template, dal quale si può partire per strutturare via via dei modelli più accurati e ben costruiti per scopi specifici.
Ma visto che da quache parte bisogna pur cominciare...

Il template si compone di sole 8 pagine.


- PAGINA 1

Qui c'è la copertina (front-cover) del documento.
E' strutturata come una griglia costruita con una tabella costituita da una sola colonna e 5 righe:

La prima riga contiene il logo della vostra azienda.
La seconda riga ospita il nome del prodotto.
La terza riga è dedicata al nome del manuale.
Infatti, uno stesso prodotto puo' essere accompagnato da piu' manuali; ad esempio, nel caso di un prodotto software, l'Installation Manual, il Getting Started Manual e l'Administration Manual.
La quarta riga ospita la versione del prodotto.
La quinta è destinata al logo del prodotto.
Nella parte più bassa della pagina, la data di emissione del manuale.

- PAGINA 2

Qui trova spazio l'Avviso legale, espresso sia in italiano che in inglese, scritto in Arial 11.

La forma dell'Avviso non è oggetto di queto articolo, ne parleremo prossimamente.

- PAGINA 3

Qui è presente l'Indice.


E' un indice aggiornabile automaticamente.
A valle di una modifica del documento, che utilizza gli stili previsti nell'Indice, basterà selezionarlo con un click del pulsante sinistro del mouse; poi, con un click del pulsante destro, dal menù a tendina selezonare la voce Aggiorna campo e, successivamente, Aggiorna intero sommario.


Su come relizzare un Indice o Sommario, per ora vi rimando al manuale di Office Word.

- PAGINA 4

Qui trovate il Capitolo 1

- PAGINA 5

Qui trovate il Capitolo 2, ove sono elencati gli stili disponibili per 5 livelli di titolo.
Per utilizzarli, basta selezionarli ed effetture un copia-incolla in ogni altra parte del documento.
La numerazione si aggiornerà automaticamente.

- PAGINA 6

Qui trovate il Capitolo 3

- PAGINA 7

Qui trova spazio la Bibliografia.
Vi sono diverse convenzioni per strutturare una Bibliografia.
In questo template viene utilizzata una struttura semplice ed efficace, ma non è detto che sia la più adatta ai vosti scopi... del resto, non abbiamo detto che è un template General Purpose?
La struttura è automatica; posizionatevi in fondo all'ultima riga e premete il pulsante Invio.
La riga successiva verrà generata automaticamente.

- PAGINA 8

Pagina di chiusura, rigorosamente vuota... per ora!

Provate a scaricarlo e ad utilizzarlo.
E' molto spartano, ma già presenta una struttura ben caratterizzata.
Prossimamente lo arricchiremo, per migliorarlo in ogni suo aspetto.
Buon lavoro!
Leggi questo articolo...

Scusate l'assenza...

Ho attraversato un periodo pesante. Tanto lavoro, qualche problema di salute in famiglia ma anche nuove idee per parecchi nuovi post. Abbiate pazienza...
Per ora vi segnalo alcuni buoni consigli per chiudere una
mail professionale.
A presto. Leggi questo articolo...

Un esempio di comunicazione efficace: il Manifesto del Celiaco

Mia moglie è celiaca. La celiachia è una malattia autoimmune che impedisce l'assunzione del glutine, una sostanza presente in un gran numero di alimenti, principalmente pane, pasta e tutti i derivati del grano e affini. Per illustrare la sua esperienza nel percorso attraverso questa patologia, ha deciso di realizzare un blog, Puntodivistaceliaco. E da questo blog, tra le altre cose, potete scaricare il Manifesto del Celiaco, una brochure che in un singolo foglio riassume e sintetizza una serie di osservazioni essenziali che forniscono un quadro istantaneo della malattia celiaca e dei presidi d'attenzione che devono essere messi in atto quando si prepara un pasto per un celiaco.
Il Manifesto è un piccolo capolavoro di comunicazione. Provate ad esaminare un qualsiasi argomento e provate a condensare in una sola pagina, in sole 15 frasi, tutte le coordinate che consentono di circoscrivere l'argomento. Vi assicuro che non è per nulla facile. Se non sapete nulla sulla celiachia, il Manifesto vi fornisce tutti i dati fondamentali, attraverso messaggi brevi e chiari, nonchè i riferimenti all'AIC (Associazione Italiana Celiachia). Leggi questo articolo...

Un buon esempio di Tutorial

Da alcuni anni siamo ormai abituati a relazionarci via Internet con la Pubblica Amministrazione e con diversi Enti Pubblici. Governo centrale, Regioni, Province, Comuni ed Enti previdenziali oggi dispongono di siti Web che forniscono diversi tipi di informazioni.
Non sempre i contenuti di questi siti sono all'altezza delle aspettative degli utenti e sarebbe abbastanza facile fare l'elenco delle manchevolezze grossolane che spesso ho rilevato. Ma stavolta voglio proporvi un esempio "in positivo".
Si tratta del sito dell'INPS (Istituto Nazionale Previdenza Sociale), che mette a disposizione degli utenti molti utili dati. Per accedere a tali dati, è necessario effettuare una registrazione, a valle della quale vi sarà fornito un PIN (Personal Identification Number).
Una volta ottenuto il PIN, si potrà effettuare il login ed accedere ad un insieme di informazioni che riguardano la nostra storia contributiva e altro ancora.
MA COME SI OTTIENE IL PIN? Con pochi semplici passaggi che sono illustrati da un breve ed efficace Tutorial consultabile on-line, nella sezione GUIDA ALL'ASSEGNAZIONE.
E' un ottimo esempio di come si possa facilitare la vita agli utenti, spiegando in soli 4 passi tutto ciò che necessita per l'ottenimento del PIN.
La veste grafica è molto elementare e si potrebbe fare di meglio, ma è in linea con l'aria di "semplicità" che permette all'utente di concentrarsi sui passaggi essenziali della procedura.
Dateci un occhiata. Leggi questo articolo...

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.
Leggi questo articolo...

Soluzioni: nota la NOTA!

In un documento tecnico è spesso utile far ricorso all'uso delle note, ma è necessario non abusarne inutilmente.

La nota tipicamente serve a puntualizzare o aggiungere elementi di conoscenza sul concetto che viene espresso e illustrato nel corpo principale del testo, in modo da non appesantire il testo medesimo.

Essa spesso fornisce informazioni "asincrone" rispetto al flusso primario, cioè informazioni complementari ma che nel corpo del testo potrebbero comunicare un fastidioso effetto "deviazione" della linea di pensiero principale.

Un esempio può essere utile a chiarire il concetto:

"...il modello è costituito da 5 elementi principali: gli Utenti, le Unità Organizzative, i Ruoli, i Profili e le Risorse. Le relazioni che intercorrono tra questi elementi..."

Il testo proposto descrive un generico modello, i suoi elementi principali e le relazioni tra tali elementi. Se abbiamo bisogno, in questo frammento, di aggiungere una distinzione tipologica tra gli Utenti che popolano il modello, possiamo usare una nota:

"... NOTA - Gli Utenti del modello possono essere suddivisi in 4 tipologie distinte: TIPO 1... TIPO 2... TIPO 3... TIPO 4... "

Ovviamente, potevamo scegliere di inserire il contenuto della nota nel corpo del testo principale, ma avremmo ottenuto per l'appunto l'effetto "deviazione", cioè avremmo costretto il lettore a deviare la sua attenzione dalla linea principale del ragionamento, finalizzata a descrivere gli oggetti critici del modello (entità e relazioni tra di esse), per acquisire delle informazioni certamente importanti ma che possono più utilmente essere proposte in un punto diverso.

Non ci credete ?

"...il modello è costituito da 5 elementi principali: gli Utenti (gli Utenti del modello possono essere suddivisi in 4 tipologie distinte: TIPO 1... TIPO 2... TIPO 3... TIPO 4...), le Unità Organizzative, i Ruoli, i Profili e le Risorse. Le relazioni che intercorrono tra questi elementi..."

Non mi sembra un granchè... molto meglio usare la nota.
Ma come identifichiamo la nota ? E dove la collochiamo ?

Distinguiamo principalmente tra:

• nota a piè di pagina (footer), collocata in fondo ad una pagina;
  

• nota di chiusura, collocata al termine del capitolo o alla fine del documento.

Classicamente, le note vengono richiamate da un numero posizionato in alto a destra della parola che necessita dell'annotazione. Possono essere numerate consecutivamente lungo tutto il testo, oppure si può usare una numerazione localizzata per ogni capitolo, ripartendo dal numero 1 all'inizio di ogni nuovo capitolo.

In alcuni contesti, le note devono essere utilizzate seguendo regole tipiche di quel contesto (ad esempio, nel caso di lavori scientifico-accademici si useranno le regole definite per le pubblicazioni di quel genere).

Io ho un'approccio abbastanza personale sull'argomento.

In primo luogo, detesto le note di chiusura. Le note spostate alla fine del capitolo (figuriamoci alla fine del documento) non servono a nulla e perdono completamente la loro utilità; le odiavo fin dai tempi in cui studiavo all'Università e non le uso mai nei miei documenti.
Immaginate una nota a pagina 13 di un capitolo di 70 pagine... per andarla a leggere devo scorrere in avanti, leggere la nota e ritornare a pag. 13... MA NON S'ERA DETTO CHE L'EFFETTO "DEVIAZIONE" ERA FASTIDIOSO ?

Non uso nemmeno le note numerate, perchè credo nel potere evocativo delle immagini.
Dovendo scrivere principalmente Manuali Tecnici nell'ambito ICT, uso due icone ben distinte, che identificano due tipi di note:

NOTE DI ATTENZIONE: vanno utilizzate per annotazioni critiche, che NON devono essere ignorate dal lettore, onde evitare danni o problemi.





NOTE DI OSSERVAZIONE: vanno utilizzate per annotazioni che rivestono un interesse specifico, ma che se ignorate non implicano particolari danni o problemi.




Le due icone colpisono l'occhio del lettore e prima ancora di leggerne il contenuto egli è già è avvisato della valenza della nota. Tali note sono collocate "in prossimità" del testo a cui si riferiscono, quindi non alla fine del capitolo.

Di seguito è illustrato un esempio:

Al prossimo post per esaminare COME USANO LE NOTE alcuni tra i più importanti vendors del mondo ICT.

Leggi questo articolo...