Scrittura tecnica 101 parte 2

Nella parte 1 ho condiviso alcuni dei miei pensieri sulla definizione vostro pubblico, la creazione di un profilo, che definisce il vostro scopo e le fasi di scrittura. Ora vorrei prendere un momento e ampliare l'area di definire il tuo pubblico. Per esempio, che cosa avete bisogno di sapere su di loro e perché.

Il primo passo è quello di scoprire il loro livello di conoscenza della materia. Sono …
livello di esperti? – ad un livello avanzato sul tema materia di livello
semi-esperto? – ad un livello intermedio sul tema
livello personale non specializzato? – non hanno alcuna conoscenza preliminare della materia

Il secondo passo è quello di trovare il loro ruolo nell'organizzazione. Sono … Hotel • Superiori? – il più alto di figure autorevoli all'interno dell'organizzazione, come il Presidente o il Vice Presidente e Direttore. Coloro che prendono decisioni che riguardano l'intera organizzazione
• Subalterni? – lettori a livello all'interno dell'organizzazione inferiore al produttore tecnico. Tutto quello che interessa è come il documento colpisce il loro lavoro Hotel • Colleghi? – lettori sullo stesso livello del technical writer, ma non necessariamente lo stesso dipartimento o settore.

E il terzo passo è quello di scoprire il motivo per cui sarà la lettura del documento tecnico, in primo luogo. Forse perché … Hotel • loro devono? o sono stati ordinati per dal loro manager
• sono veramente interessati al tema Hotel • saranno solo utilizzeranno come riferimento, mentre il completamento dei loro mansioni quotidiane?

Ci si potrebbe chiedere perché questi passaggi sono anche importanti per uno scrittore tecnico. Beh, il motivo è perché se si scrive o progettare il documento nel contesto sbagliato, il colore o il layout potrebbe fare o rompere il progetto INTERO.

Ad esempio, non si vuole scrivere un documento ai superiori senza alcuna conoscenza della materia in termini altamente tecnici, né si vuole scrivere in modo condiscendente sia. Ci deve essere un equilibrio professionale tra i due che si impegnerà il discente e aiutarli a assimilare le informazioni in modo efficiente e utilizzare il documento tecnico efficacemente

Let &';. S un'occhiata a un altro esempio. Si sta scrivendo per un gruppo di vostri coetanei che hanno un livello di conoscenza intermedio avanzato. Cosa ne pensi sarebbe la risposta dei lettori, se è stato creato un documento che spiega anche il termine tecnico più basso, come quello che è un &'; Mouse &'; o come a “ &" ;? clic Sarebbero probabilmente annoiati e offesi, allo stesso tempo, don &'; la t si pensa

Così ancora una volta, la chiave è quello di definire il tuo pubblico, chiedendo a quante più domande possibile?. Se si finisce con troppi livelli e ruoli organizzativi all'interno del tuo pubblico, potrebbe essere necessario creare 3 documenti separati, come una guida per principianti, intermedio e Guida per l'utente Guida per utenti avanzati.

Nella parte 3 voglio concentrarsi su come raccogliere le risorse e da dove, e quali sono gli aiuti grafici o spunti all'interno documentazione tecnica e come crearli. Fino alla prossima volta …

Risorsa: Scrittura tecnica:. Principi, strategie e Letture a cura di Diana C. Reep (. 5 ed) Pearson Education, Inc. 2003. Hotel