PRIMO ASSIOMA UNIVERSALE del TW

SE IL PRODOTTO ESISTE E IL MANUALE NON ESISTE,
IL PRODOTTO NON ESISTE.

SE IL PRODOTTO NON ESISTE E IL MANUALE ESISTE,
IL PRODOTTO ESISTE.

Chi ha formulato per primo questo atipico assioma?

Probabilmente io... ma quasi certamente no.
Nel senso che lo penso e lo affermo, quindi lo enuncio, sulla scorta di letture effettuate, traendo spunto dal lavoro di TWs più esperti di me e sintetizzando un insieme di esperienze, tra cui le mie.
Ma alla fine fine l'eventuale paternità di questo giochino dialettico è una ben povera questione.

E' invece molto più importante osservare che anche se avete il prodotto migliore del mondo, se non sarà accompagnato da un adeguato set di documenti, nessuno potrà apprezzarlo. Aggiungo che l'attività di marketing in tal senso non è meno importante della documentazione tecnica specifica, tanto per avvalorare oltremodo l'assioma.

Perchè ho definito l'assioma "atipico"?
Perchè gli assiomi non si dimostrano; ma questo, pur non avendo alcun bisogno di essere dimostrato.. E' DIMOSTRABILE! Non ci credete?
Due veloci esempi:

• il movimento Open Source

• IKEA

Quando andavo all'Università, i Linux guru erano ammantati di un alone di santità o erano indicati come l'incarnazione più affascinante del "carbonaro-hacker-anarchico" dell'informatica.
Ma se qualcuno pensa che l'Open Source, ormai diventato uno dei motori più importanti dell'ICT Business, debba il suo successo al genio genialoide di pochi eletti, il cui capostipite è Linus Torvalds, sbaglia clamorosamente.
Il segreto del successo del mondo Linux e affini è basato sugli "HOW-TO", cioe SUI DOCUMENTI, spartani ma efficaci, che ogni appassionato sviluppatore Opens Source produce a supporto del suo lavoro, consentendo a tutti gli altri di capire CHE COSA si è sviluppato e COME FUNZIONA.
Senza gli HOW-TO forse l'Open Source sarebbe morto nella culla, ucciso dal morbo dell'inutilizzabilità di soluzioni non adeguatamente documentate.

IKEA può essere definito come un modo di pensare l'arredamento in "filosofia RISC" (Reduced Instruction Set Computer), che tradotto per i non informatici significa "badiamo al sodo".
Una delle principali carte vincenti di IKEA sono i libretti d'istruzione per il montaggio dei mobili.
I suoi fan sostengono che siano chiarissimi e che montare un mobile attraverso di essi risulta essere particolarmente semplice... ed economico, perchè consente un risparmio non banale sul prezzo del mobile medesimo.
Quindi anche per IKEA, la qualità della documentazione associata ai prodotti non è un fastidioso orpello ma un elemento importante della sua logica di Business.

Vi sfido a fornire una tesi convincente in grado di smontare l'assioma... buona fortuna!

P.S.

... ne avrete bisogno ...
Leggi questo articolo...

Ancora sugli acronimi ... e affini

In questo post, che conclude il trittico composto dagli articoli del 12 Agosto e del 18 Agosto, vi propongo alcune annotazioni da tenere a mente.

Un acronimo può essere influenzato dalla lingua d'origine.

In Italia abbiamo sempre sentito parlare dell'OLP (Organizzazione per la Liberazione della Palestina), ma nei paesi anglosassoni avremmo sentito parlare di PLO (Palestine Liberation Organization).

Così come in Francia sentirete indicare come SIDA la malattia che tutto il resto del mondo chiama AIDS (Acquired Immune Deficency Syndrom).

Quindi si deve porre attenzione, in alcuni casi, all'utilizzo dell'acronimo espresso nella forma più adatta alla lingua di chi poi dovrà interpretarlo, anche perchè molti acronimi sono diventati ormai di uso comune, al punto che qualcuno li usa alla stregua di "parole" vere e proprie (USA, JFK, RAM, CD, FIAT, ENEL, ONU, FAO, ...).

In molti settori tecnico/scientifici esistono regole specifiche e acronimi/sigle "speciali" che devono essere appropriatamente utilizzati.

Nel campo della Chimica, ad esempio, il Rame è Cu (dal latino Cuprum), l'Oro è Au (Aurum), il Carbonio è C (Carbonium) e l'Elio è He (Helium).
Il Metano è CH4 (derivante direttamente dalla formula di struttura del Metano, la cui molecola è formata da un atomo di Carbonio e 4 di Idrogeno).
I CloroFluoroCarburi (i composti responsabili del buco dell'Ozono, scoperti negli anni '30 del secolo scorso), vengono indicati con un acronimo "vero e proprio", CFCs, derivante dall'espressione inglese (Chlorofluorocarbons).
Gli isotopi di uno stesso elemento vengo indicati dal nome stesso dell'elemento seguito da un codice numerico o, equivalentemente, dal simbolo dell'elemento preceduto dal suddetto codice numerico.

Ad esempio:
Carbonio 14 --> 14C
Elio 3 --> 3He

Come vediamo quindi, in quest'area esiste un set di regole per la nomenclatura di elementi sempici e dei composti, che sono regole PROPRIE E SPECIFICHE di questo settore.

Questa osservazione può essere ritenuta valida in ogni altro campo.

In ambito commerciale/legale, ad esempio, è largamante usata, soprattutto nel mondo anglosassone, la & ('e' commerciale) per associare due o tre nomi/soggetti che identificano il nome di una società.
Ad esempio, Goldman&Sachs (G&S), Dolce&Gabbana (D&G), AT&T e così via.

Nell'ambito della Fisica, le diverse grandezze fisiche vengono espresse secondo le regole previste dal Sistema Internazionale.

Questi e altri esempi che potrei continuare ad esporre, ci indicano chiaramente che quando ci apprestiamo a scrivere un documento tecnico relativo ad un ambito ben definito, dobbiamo conoscere le regole di nomenclatura e le convenzioni simboliche proprie di quell'ambito.

A QUESTO PUNTO... abbiamo finito con gli acronimi? OVVIAMENTE NO!

Ma spero che i concetti basilari esposti possano aiutarvi ad eliminare almeno gli errori più comuni, che spesso mi capita di rilevare.
Per poter sopravvivere "nell'inferno degli acronimi", vi segnalo due siti che possono essere utili:

www.acronyma.com

www.pchell.com/acronyms

Se ne trovate altri, segnalatemeli!
Leggi questo articolo...

Ma quale template per i nostri documenti?

Ormai siamo convinti che dobbiamo utilizzare un template per realizzare il nostro manuale.
MA USEREMO UN SOLO "general purpose" template o dobbiamo avere dei template specifici per ogni tipo di documento? La risposta più corretta, ma anche la più banale, è la seconda.
Per ogni documento dobbiamo utilizzare il template più adatto, che meglio delimita il tipo e la qualità dei contenuti che devono essere organizzati per uno scopo specifico.

Ad esempio, in un Installation Manual dovremo predisporre una sezione PREREQUISITES che dovrà ospitare tutte le indicazioni preliminari che devono essere verificate prima di iniziare il processo d'installazione.

Se invece dobbiamo realizzare un Getting Started Manual, assumiamo che il prodotto sia stato correttamente installato e non abbiamo bisogno di specificare alcun prerequisito.

All'inizio tuttavia non è semplice individuare correttamente tutti gli elementi che devono essere collocati in un template.

Posso azzardare due consigli:

• COPIATE DAI MIGLIORI
  

• INDIVIDUATE UN TEMPLATE "FLESSIBILE" E MIGLIORATELO PROGRESSIVAMENTE

Il primo consiglio è forse il migliore possibile.
Non siate presuntuosi, nessuno inventa nulla. Prima di poter proporre qualcosa di VERAMENTE ORIGINALE dovete studiare molto e... COPIARE molto. Solo quando sarete veramente padroni del vostro mestiere (alcuni anni ?...) potete tentare di impiantare soluzioni innovative. Nell'attesa, guardate cosa fanno gli altri (IBM, HP, SUN, MICROSOFT...), che vantano esperienze decennali e investono ogni anno risorse ingenti nella produzione di documentazione. Ispiratevi... vi assicuro che non è una perdita di tempo.

Il secondo sembra contraddire la prima parte di questo post, ma solo in apparenza. Si inizia con un template "general purpose", robusto e flessibile, e poi via via si specializza.
Ok, ma in pratica... che vuol dire ?
Lo vedremo presto... abbiate pazienza.
Ciao!

Leggi questo articolo...