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...
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.
1 commento:
Fabulous, what a web site it is! This website presents useful information to us, keep it
up.
Here is my homepage sem services
Posta un commento