La prima cosa che un bravo Technical Writer dovrebbe fare, ancora prima di iniziare a scrivere, è quella di riflettere attentamente sui nomi da assegnare ai propri documenti e ai file che li contengono.
Purtroppo molto spesso nelle aziende regna la più totale anarchia su tale questione.
In mancanza di regole, ogni utente si sente libero di chiamare i file nel modo che gli è più congeniale, ricorrendo a nomi di fantasia o a misteriosi codici numerici, poco o per nulla informativi.
Questa anarchia rende anche molto difficile, se non addirittura impossibile, sia l’archiviazione che la rintracciabilità dei file.
Io mi sono dato delle regole che sembrano funzionare e che vorrei condividere con voi.
Innanzitutto ho iniziato considerando lo scopo che ha il nome di un documento/file. Il nome dovrebbe permettere l’identificazione univoca del documento/file in mezzo agli altri, associandolo al suo contenuto, come il codice fiscale che corrisponde univocamente alla nostra identità.
Il nome poi dovrebbe essere facilmente decodificabile per permettere anche agli altri di capire il nostro codice e quindi l’identità del file.
Queste considerazioni mi hanno portato a stabilire la regola seguente:
Acronimo prodotto_Codice documento_Codice lingua_Versione documento
Acronimo prodotto è il nome del prodotto (es. CPU12345).
Codice documento identifica il tipo di documento. Ho definito questo codice perché l’esperienza mi ha insegnato che è meglio mantenere il nome del file il più corto possibile. Nomi troppo lunghi potrebbero infatti creare problemi al sistema operativo, ad esempio durante le operazioni di backup. “InstMan” è meglio di “Installation Manual”.
Codice lingua indica la lingua utilizzata.
Versione documento è l’indice di revisione del documento (es. 1.0). L’ho inserito all'estrema destra del nome del file subito prima dell’estensione .docx perché così mi sembrava più veloce individuarlo, anziché disperderlo all'interno del nome.
Nella seguente tabella, ecco un paio di esempi:
Nella tabella successiva, la convenzione linguistica:
Come vedete, la regola è semplice e flessibile.
Ora ... basterà rispettarla!
---------------------------------------------------------------------------
Su questo argomento, potete leggere anche:
Regole di Naming per la documentazione.
Nessun commento:
Posta un commento