domenica 21 giugno 2009

Regole di Naming per la documentazione

Quando nel 2005 iniziai il mio lavoro, per prima cosa dovetti classificare centinaia di documenti realizzati in azienda, all'insegna della più completa anarchia, nei precedenti 4 anni.
La casistica disponibile era sorprendente:
  • documenti sostanzialmente identici salvati con nomi diversi
  • documenti notevolmente diversi salvati con lo stesso nome
  • documenti relativi allo stesso prodotto ma concettualmente diversi (la Scheda Tecnica, il Manuale d'Installazione, il Manuale dell'Amministratore,...) anch'essi identificati dallo stesso nome
  • documenti relativi a versioni diverse dello stesso prodotto salvati con nomi "mimetici" rispetto alla versione
  • documenti salvati con nomi assolutamente scorrelati dal contenuto
  • altro ancora... che al sol pensier ancor mi dole il cor...
Il lavoro di classificazione mi ha impegnato per 3 mesi e la prima cosa che ho fatto è stata quella di definire UNA REGOLA DI NAMING.
Non esistono indicazioni univoche su come impostare una regola di Naming della documentazione aziendale. Anche i guru del Technical Writing di matrice anglosassone, forniscono indicazioni assolutamente ragionevoli e ispirate a principi di "buon senso" che ognuno di noi può identificare autonomamente e deve essere in grado di adattare alla propria realtà lavorativa.

IL PRINCIPIO FONDAMENTALE è:
NON SI INIZIA A CLASSIFICARE NULLA SENZA UNA REGOLA DI NAMING.

La regola che ho adottato e che è ancora in vigore, è estremamente semplice e si struttura in questo modo:

ACRONIMO PRODOTTO/PROGETTO-VERSIONE PRODOTTO/PROGETTO-NOME MANUALE-VERSIONE DOCUMENTO-NOME AZIENDA/CLIENTE

Vediamo due esempi:

NMM-210-Installation_Manual-100-EngNetServices.pdf
Questo nome indica l' Installation Manual del prodotto Network Monitoring Module (NMM), giunto alla versione 2.1.0; la versione del documento è la 1.0.0 e il nome dell'azienda che lo produce è EngNetServices.

PPWC-340-Administration_Manual-120-ENELERGSUN.doc
Questo nome indica l'Administration Manual del prodotto Profile Provisioning Web Console (PPWC), sviluppato per il cliente ENELERGSUN, giunto alla versione 3.4.0; la versione del documento è la 1.2.0.

Come vedete, non è necessaria un'intelligenza cartesiana per definire una regola di Naming.

Tipicamente, ne fanno uso le aziende di alto livello e ben organizzate, in cui la produzione e la classificazione della documentazione rappresenta un'elemento importante della filosofia di business.
In particolare, le aziende che si sottopongono ad un percorso di certificazione di qualità dei processi produttivi, adottano regole di Naming anche molto più articolate di quella che ho adottato io.

Ovviamente questa regola non è la migliore possibile ma funziona abbastanza bene.
In questo modo i nomi apposti ai documenti divengono "parlanti", nel senso appena illustrato.

L'efficacia di una regola di Naming dipende anche dal contesto.
L'ACRONIMO PRODOTTO/PROGETTO ha più senso in un'ottica "interna" che esterna.
Quindi questa regola va benissimo per la documentazione tecnica, molto meno per la documentazione di Marketing, dove anche il nome del documento deve, in genere, essere più "esplicito".
Nulla vieta di adottare 2 o 3 regole di Naming distinte, all'interno dell'azienda, purchè siano ben specificate e note a tutti gli appartenenti della medesima.
Io preferisco una regola unica, semplice e flessibile quanto basta.

Ma ovviamente e come sempre, non si può avere tutto dalla vita; in quest'ottica vediamo in che modo si potrebbe modificare la regola illustrata se volessimo ottenere nomi "più compatti" (ma meno "parlanti").

Immaginiamo di assegnare un codice numerico a tutte le tipologie di documentazione previste per un generico prodotto:

001 - Technical Specification
002 - Installation Manual
003 - Getting Started Manual
004 - Administration Manual
005 - Product Manual
006 - Developer Manual

Riprendiamo gli esempi precedenti:

NMM-210-Installation_Manual-100-EngNetServices.pdf
NMM-210-002-100-EngNetServices.pdf

PPWC-340-Administration_Manual-120-ENELERGSUN.doc
PPWC-340-004-120-ENELERGSUN.doc

Come vedete, la regola induce a nomi più compatti ma meno intellegibili.

Ovviamente, una regola di Naming può essere utile anche per classificare i vostri documenti privati.

Come sempre, vi sottopongo la mia esperienza senza la pretesa di proporre formule esaustive, ma con l'intenzione di fornirvi spunti utili per una migliore gestione della documentazione.
Usate le regole di Naming... ne trarrete solo vantaggi.
Leggi questo articolo...

giovedì 11 giugno 2009

Contenuti di una pagina Web: la regola "F shape"

Alcuni giorni orsono la mia fidata collega Claudia, che mi aiuta nella realizzazione della documentazione aziendale, mi segnalava la sua difficoltà nel documentare una specifica funzionalità di una Web Console per l'amministrazione di uno dei nostri prodotti.
Ci mettiamo insieme a guardare il problema... e continuiamo a non vederlo.

Sarà la stanchezza del fine giornata ? Dopo un pò di tempo (diciamo un pò troppo...) ci accorgiamo della label identificativa di un accordion pane posizionato in basso a destra... di colore celeste su sfondo chiaro!

Eppure nei nostri prodotti questo elemento grafico viene usato con una certa frequenza... perchè stavolta non lo avevamo visto?
Dopo un breve smarrimento mi è ritornata in mente una delle lezioni più famose di Jacob Nielsen, il guru riconosciuto della Web "usability" e della comunicazione efficace dei contenuti Web.


La figura precedente la trovate sul suo sito www.useit.com, che vi invito a visitare e saccheggiare... intellettualmente parlando.
La figura rappresenta ciò che io chiamo la "densità di sguardo", cioè la tendenza a posizionare gli occhi di un lettore di una pagina Web prevalentemente su certe zone della pagina rispetto ad altre.
Le zone rosse sono quelle dove gli occhi del lettore tendono a posizionarsi più frequentemente; via via, la frequenza diminuisce virando dal rosso al giallo, al blù fino al grigio.
Tale ricerca ha suggerito che sia conveniente "addensare" i contenuti significativi di una pagina Web nella zona alto-centrale-sinistra, perchè è in quella zona che, prevalentemente, andiamo con lo sguardo a cercare le informazioni.

Quando scriviamo per il Web o progettiamo applicazioni Web, questa è una delle regole auree che bisognerebbe sempre osservare.

Quindi, se poi alle ore 19 ci si ritrova con un elemento grafico CELESTE... SU SFONDO CHIARO... IN BASSO A DESTRA... se proprio non lo si vede al primo colpo... siamo, almeno in parte, giustificati!
Leggi questo articolo...

sabato 6 giugno 2009

Saper scrivere... il Curriculum Vitae: una breve mappa per non perdersi

Come si scrive un buon CV? In rete esistono decine di guide, centinaia di pagine Web, più o meno dettagliate, che cercano di spiegare come si scrive un CV efficace.

Ho avuto modo di leggerne alcune ma alla fine si avverte la sensazione che l'unica certezza sembra consistere... nel non avere certezze.

Chi propone schemi validi per tutti gli usi, scivola necessariamente in una brodosa generalità priva di generalizzazione.

All'opposto, chi propone idee anche interessanti ma eccessivamente "verticali" (CV audiovisivi, "You Tube style" tanto per capirsi), rischia di condurre la composizione del CV in una specie di fiordo, eccessivamente angusto e particolare, magari adatto ad una particolare nicchia di mercato ma di scarsa efficacia nella maggior parte dei casi.

Questo post non intende aggiungere un altra manciata di pagine Web a tutte quelle già presenti sull'argomento, ma sollevare delle bandierine su alcuni passaggi chiave che sarebbe utile tener sempre ben presenti.
Ho avuto modo, nella mia professione, di dover condurre delle selezioni in team con altri colleghi e alcune delle osservazioni che vi propongo di seguito nascono anche da questa esperienza personale e diretta.

Focalizziamo i seguenti elementi:

- USATE UN FORMATO STANDARD PER IL VOSTRO CV
- SINCERI NELLA SOSTANZA MA INTERESSANTI NELLA FORMA
- HO FORSE FATTO TROPPO POCO... ALLUNGHIAMO LA MINESTRA!
- TROPPA ROBA... COSA TAGLIARE ?
- LA TRIADE MALEDETTA: Professionista, Serio, Motivato
- QUELLO CHE SCRIVETE NON VALE NULLA SE NON LO SCRIVETE BENE
- ALLEGATE AL CV LA LETTERA DI PRESENTAZIONE
- NUOVE TENDENZE: FATE DEL VOSTRO NOME UN BRAND


- USATE UN FORMATO STANDARD PER IL VOSTRO CV

Oggi, nella composizione di un CV, si è largamente affermato l'uso del "CV in Formato Europeo". Non si tratta di chissà quale incredibile parto dell'umano intelletto nè apporta alcun significativo set informativo aggiuntivo rispetto ai CV un pò più naive che potevamo leggere in passato.

E' SEMPLICEMENTE PIU' COMODO DA LEGGERE per il selezionatore, perchè la sua struttura è standard; se un selezionatore deve leggere decine di CV, in quelli scritti nel Formato Europeo è più semplice andare a reperire le informazioni d'interesse, perchè appunto esse andranno ad
occupare una posizione predefinta nella struttura del documento.
Se invece scrivete un CV in un formato più "personale", il selezionatore dovrà spulciarlo riga per riga per individuare le necessarie informazioni... quindi dovrà gestire una difficoltà aggiuntiva.

E VOI NON VORRETE INDISPETTIRE IL VOSTRO SELEZIONATORE VERO ? :-)

- SINCERI NELLA SOSTANZA MA INTERESSANTI NELLA FORMA

In un CV non conviene mentire. Un selezionatore accorto vi potrà smascherare con un soffio.
La bugia più frequente che mi capita di osservare riguarda la conoscenza della lingua inglese.
Vantare certificazioni indimostrabili o dichiarare il proprio inglese "fluent" può rivelarsi un boomerang disastroso, che può crollare in 5 minuti di conversation o a valle di una traduzione incerta di una mezza pagina.
Anche un sedicente DBA Oracle può essere "smontato" con poche precise domande.
Non raccontare balle non significa rinunciare a valorizzare le proprie esperienze, presentandole nel modo efficace.

Dichiarare l'ottenimento di una certificazione CISSP può darvi delle buone chance per una posizone si Security Consultant; ma se aggiungete due righe per indicare nell'ambito di quale progetto avete usato le competenze attestate nella certificazione, arricchirete di significato questo dato.

Se invece siete un animatore turistico e specificate di aver gestito un concorso canoro, non dimenticate di aggiungere che avete supervisionato ogni aspetto tecnico-artistico-organizzativo della manifestazione, se aspirate a ripercorrere le orme di Fiorello!

In altri termini, non inventate balle ma imparate a "vestire" in modo interessante le vostre "reali" competenze.

- HO FORSE FATTO TROPPO POCO... ALLUNGHIAMO LA MINESTRA!

Nella mente dei candidati più giovani spesso s'affaccia l'angoscia del "CV leggero".
Poche esperienze (se si è giovani e magari neo-laureati è quasi inevitabile), "avvertite" dal candidato come terribilmente non significative.
E invece di scavare per far emergare il meglio possibile dal materiale disponbile, si è mortalmente attratti dalla risposta sbagliata: allunghiamo la minestra!
Testo scritto in Arial 14, qualche riga vuota in più, una dozzina di avverbi coreografici in ordine sparso, magari una lunga lista di hobbies... NON VI ILLUDETE... non trarrete in inganno nessuno.
Meglio un CV sintetico e concreto che una poco abile operazione di autogol-marketing!

- TROPPA ROBA... COSA TAGLIARE ?

Un CV non è un'autobiografia.
Il selezionatore non ha fatto probabilmente nulla di malvagio per meritarsi la punizione di dover leggere il diario della vostra vita!
Se però avete avuto una carriera ricca di esperienze, non è nemmeno giusto auto-censurarsi per paura di dover presentare un CV "troppo lungo".
D'altra parte, a volte bisogna saper selezionare gli aspetti che devono emergere in funzione della figura professionale e della posizione per la quale ci proponiamo.
Se vogliamo ricoprire il ruolo di Business Developer in una Software Company, indicare nel CV che avete lavorato per 4 anni come programmatore Visual Basic può risultare non essenziale.
Se volete lavorare come DJ in una discoteca, segnalare la partecipazione ad un corso di paracadutismo nulla aggiunge alle vostre potenzialità.
In sintesi, cerchiamo di collezionare in modo mirato le nostre frecce migliori in funzione del bersaglio che vogliamo colpire.

- LA TRIADE MALEDETTA: Professionista, Serio, Motivato... ?!?

Mi riprometto prima o poi di lanciare una raccolta di firme per gli avverbi e gli aggettivi CHE NON SI DEVONO MAI PIU' USARE IN UN CV; tra tutti questi, credo che LA TRIADE MALEDETTA sia "Professionista, Serio, Motivato".

A chi usa tale triade io vorrei chiedere... PERCHE'?
Perchè pensate di distinguervi agli occhi di un selezionatore usando questi termini ?
Pensate che esista un selezionatore intenzionato ad assumere un DILETTANTE, BUFFONE E DEMOTIVATO ? Ad un'azienda che riceve centinaia di CV ogni anno, gli eccessi verbali, i toni saccenti ed iperbolici suonano falso come un televenditore di coltelli che non si devono affilare mai!

- QUELLO CHE SCRIVETE NON VALE NULLA SE NON LO SCRIVETE BENE

Evariste Galois morì nel 1841, all'età 20 anni, in un duello: dai 17 anni alla sua morte, gettò le basi di tutta la matematica moderna... in sole 60 pagine di appunti disordinati e misteriosi, sparse i semi che hanno generato tutte le vie della matematica più avanzata degli ultimi 150 anni... quelle 60 pagine hanno rischiato di andare perse... per un difetto di comunicazione, avremmo potuto perdere le intuizioni di un genio assoluto dell'umanità e la Scienza e la Tecnologia che conosciamo oggi... non sarebbero state la stesse.

LE VOSTRE MIGLIORI DOTI NON SERVONO A NULLA E A NESSUNO... SE NON LE SAPETE COMUNICARE!
E NELLA COMUNICAZIONE SCRITTA LA FORMA E' IMPORTANTE!

Anche lo skill più interessante può venire affossato da errori grammaticali, sintassi incerta e una cura superficiale degli aspetti formali... state scrivendo il vostro CV, non la lista della spesa!
La cura della forma si acquisisce con l'attenzione alla scrittura, va affinata giorno per giorno, allenandovi alla riscrittura dei contenuti del vostro CV. A tal proposito potrebbe esservi utile "giocare" con i concetti che trovate in questo blog, nella sezione "Esercizi di riscrittura".

- ALLEGATE AL CV LA LETTERA DI PRESENTAZIONE

Su questo argomento ho già scritto un post a cui vi rimando.

- NUOVE TENDENZE: FATE DEL VOSTRO NOME UN BRAND

Il CV può non essere l'unico modo di presentarsi ad un'azienda. La rete è piena di headhunters, "cacciatori di teste" che stanno cercando persone da inserire negli organici di un'azienda e che scandagliano la rete per individuare i candidati potenzialmente più interessanti, da convocare per un colloquio.
Quindi dovete "essere nella rete", attraverso un sito Web personale, un Blog, sfruttando le infrastrutture del Social Network per veicolare i contenuti professionali che pensate di poter offrire. Se siete in grado di "organizzare e comunicare" il vostro potenziale, forse qualcuno vi contatterà prima ancora di ricevere il vostro CV.
E comunque, anche questa attività di auto-promozione va segnalata nel CV...
Leggi questo articolo...