Concetti contenutistici per la documentazione tecnica
Una documentazione deve istruire sull'uso completo e sicuro di un prodotto. Ciò tuttavia non dice ancora niente su quali informazioni devono essere comunicate nelle istruzioni. I contenuti necessari dipendono essenzialmente dalla funzione svolta dalle istruzioni e dai soggetti ai quali si rivolgono. Le istruzioni d'uso per l'utente finale richiedono contenuti diversi da quelli delle istruzioni di assistenza per i propri tecnici.Un concetto contenutistico non deve solo definire le informazioni da comunicare, ma anche come tale comunicazione avviene. Dal punto di vista dell'utente si tratta dell'accesso più immediato possibile alle informazioni, dal punto di vista del redattore della realizzazione efficiente e del riutilizzo di informazioni di validità generale nelle istruzioni.
Il nostro procedimento:
- Familiarizziamo con i vostri prodotti, con i loro casi di impiego e con i gruppi di destinatari.
- Sviluppiamo un concetto contenutistico strutturale su diversi livelli: documenti, capitoli, sezioni.
- Definiamo il concetto contenutistico a livello comunicativo: istruzioni, descrizioni, avvertenze, coordinamento di testo e immagine.
- Definiamo norme di formulazione e di composizione.
- Identifichiamo informazioni riutilizzabili, ad esempio avvertenze, introduzione alla documentazione, indirizzi, illustrazioni di orientamento.
- Realizziamo pagine modello di esempio.
- Mettiamo per iscritto le regole e le decisioni in guide e strumenti redazionali
I vostri vantaggi:
- Adattamento della vostra documentazione ai vostri prodotti, gruppi di destinatari ed altri requisiti
- Base per il riutilizzo di informazioni per tutti i documenti
- Comunicazione di informazioni senza sprechi: nella documentazione si trova esattamente il necessario per i compiti dei singoli gruppi di destinatari
- Base di una composizione industriale della documentazione a partire da moduli di informazione, basata sull'utilizzo di un sistema