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:
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!
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
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!
Nessun commento:
Posta un commento