Scrittura tecnica per terrorizzata
Introduzione
A volte può essere oltre preventivo degli individui o delle aziende per assumere un produttore professionista per richiamare la loro documentazione tecnica. Anche se in un mondo ideale tutta la documentazione tecnica dovrebbe essere prodotta da un esperto altamente addestrato, purtroppo non viviamo in un ideale. Nello stesso senso che molta gente tenterà di riparare i loro propri elettrodomestici, molta gente tenterà di redigere a qualità i documenti tecnici. Appena come fiddling con un tostapane può provocare electrocution, tentare di redigere i documenti tecnici da zero senza consiglio anteriore infine provocherà il guasto. Come una regola pratica che approssimativa dovreste cercare sempre per impiegare un esperto, ma se per che cosa motivo non potete e voi sono il poveri sfavorevoli che hanno avuti funzioni della documentazione rifilate su loro, non despair. Questa guida del riassunto descrive alcune delle abilità che di nucleo dovrete portare alla vostra scrittura, dei pacchetti di programmi tecnici, di informate da essere di convenzioni potete considerare e delle cose definite da evitare. Eventualmente anche se non avete scritto mai una frase nella vostra vita circa qualche cosa vago tecnico avrete per lo meno, una più vasta immagine di che cosa la scrittura tecnica richiede.
Che cosa è scrittura tecnica?
La scrittura tecnica abbastanza unsurprisingly, si riferisce alla scrittura che è tecnica. Anche se questo può sembrare come una definizione fallace, è importante da ricordarsi di. Troppi autori tecnici fanno l'errore di generazione della documentazione che è o troppo tecnica, o ugualmente 'letterario '. Un buon autore tecnico dovrebbe potere registrare l'equilibrio fra i due per soddisfare l'utilizzatore finale della documentazione. La scrittura tecnica è mólto come invisibile dominante ma grazioso dell'aria fresca, molto. Nel mondo metallico bizzarro in cui ci troviamo, la scrittura tecnica è dappertutto. I manuali del software, le guide dell'utente per gli elettrodomestici, gli opuscoli didattici, i email, le lettere, i rapporti, i rapporti di notizie tecnici, le statistiche e le biografie sugli sport della televisione mostra che tutti sono esempi di scrittura tecnica a cui la gente è esposta sopra ad una base quotidiana. Se mai avete provato a programmare le regolazioni di tempo su un magnetoscopio domestico ed avete scagliato il manuale attraverso la stanza nella repulsione, avete gettato una parte di scrittura tecnica (anche se ovviamente non molto buona!).
Troppo cronometra la letteratura tecnica è prodotto dai produttori con non una stretta abbastanza grande di tecnologia, o dai tecnologi che difettano di una capacità di scrivere. Come un futuro autore tecnico voi deve percorrere la linea molto fragile di essere tecnicamente informato nel vostro field(s) dell'esperto così come essere 'un buon 'produttore (in contrasto con i produttori 'difettosi 'che possono essere trovati solitamente attaccare le signore anziane dolci o qualcosa). La documentazione tecnica è prodotta solitamente per due gruppi di utenti distinti, vale a dire utenti livellati esperti ed utenti ingenui. Poichè un autore tecnico uno delle vostre prime mansioni deve scegliere che pubblici state scrivendo per, a cui lo porta deftly:
Conosca il nemico thy
Come il vecchio cliché va, tutto un critico. Ciò è particolarmente vero per reazione la maggior parte della gente sensata una volta affrontata a scrittura tecnica. Come è stato evidenziato nell'esempio del magnetoscopio qui sopra, la scrittura tecnica può essere impenetrabile all'utilizzatore finale. Se questo è il caso, è perché chiunque ha scritto la documentazione, non si è preoccupato di identificare i loro pubblici e di scrivere al loro livello. Sembra un punto evidente da fare, ma uno che è trascurato spesso, che l'utente dei documenti vostri sta generando, non può realmente essere un esperto. Ovviamente se state generando un documento su un prodotto particolare dell'esperto per un gruppo di utenti avanzati particolare (un buon esempio potrebbe verificare il software per i coordinatori del sistema di elaborazione) allora che dovrete comporre questo siete un senso interamente differente che se state generando per esempio, un manuale tecnico per il software di calcolatore del mercato totale avete puntato sull'utente domestico inesperto. Una delle prime mansioni che dovete compire prima che persino mettiate la penna a carta, della barretta alla tastiera, dovete identificare chi l'utente dei vostri documenti sarà e costruirà i documenti puntati su che group(s) particolare dell'obiettivo. Se ottenete questa fase corretta, dovrebbe evitare i vostri documenti che sono gettati attraverso le stanze nel disturbo!
Progettando per la perfezione
Una volta che avete identificato il mercato di obiettivo per i documenti che genererete, dovrete cominciare progettare come i documenti saranno organizzati. Questo processo dipende in gran parte da che documentazione sta producenda, ma potete seguire alcune regole pratiche approssimative. In primo luogo, se i documenti devono sostenere un prodotto particolarmente dettagliato (quale un'applicazione informatica) ottengale rapidamente le vostre mani grubby come potete. Esaminando il prodotto potete formulare dettagliatamente un programma dell'attacco e cominciare a comporre una struttura organizzativa. Mentre state esplorando dettagliatamente il prodotto, le note copiose dell'introito, come fare questo durante le fasi esplorative iniziali possono conservarle tempo che può essere assolutamente vitale se state lavorando alla scadenza. Anche nella fase di progettazione che dovete accertarsi là è una consistenza alla disposizione e struttura organizzativa per il documento. Selezioni le convenzioni di numerazione, divida gli stili in paragrafi e generi le idee generali per gli scopi della disposizione ora e salv tempo vitale più successivamente.
Lasci una brutta copia dentro
Prima di tuffarsi headfirst nella generazione della documentazione, brutta copia verso l'esterno ogni sezione in primo luogo. Ciò concederà riordinare se i documenti che sono generati non hanno seriamente 'un flusso 'logico senza avere effetto sul progetto. Molti documenti tecnici (particolarmente per i prodotti più dettagliati) si compongono delle ripetizioni numerose (ed in alcuni casi praticamente countless). Ciò è perché il prodotto sposta e cambia col tempo ed una delle funzioni principali di un autore tecnico deve seguire i progressi di questi cambiamenti ed accertarsi che siano tutti buono documentati. I buoni autori tecnici spingeranno sempre i loro documenti attraverso altretante brutte copie come umanemente possibile, raffinando su ogni brutta copia, fino a che non raggiungano una posizione per cui (ed il loro datore di lavoro) sono soddisfatti che la documentazione è attuale, esatta e una riflessione allineare del prodotto o procedilo documenta.
Il diavolo è in dettaglio
Come scrittura già identificata e tecnica è denominato quello perché è tecnico in natura. La parte di essere tecnica deve essere precisa e la parte di precisione deve essere dettagliata come umanemente possibile. Anche se i documenti che state generando sono per un avanzato ed il gruppo di utenti tecnologicamente reso sofisticato, la vostra documentazione deve mettere a fuoco sui particolari di un processo, o nel usando un prodotto. Ciò può essere un'abilità difficile da compire, ma non se scrivete ai vostri pubblici. Non supponga mai che il lettore sa che qualche cosa circa il prodotto o il processo è documentato, ma nel caso utenti avanzati/esperti abbia almeno il buonsenso riconoscere il fatto che probabilmente non devono dirsi a come utilizzare l'apparecchiatura funzionano sopra una base quotidiana. Nel descrivere come effettuare un'attività o un'operazione particolare, identifichi ogni fase in questione (numerile se questo misura le convenzioni del tipo che del documento state generando) ed accertare l'esattezza di che cosa gli avete scritto a prova voi stessi, o persino migliorare, corda in un volontario dello stesso livello di abilità dell'utilizzatore finale.
Scelga l'attrezzo di destra per il lavoro
Anche se è possibile generare i documenti tecnici usando la pergamena e l'anima, non è consigliabile. Molte applicazioni del software dell'esperto esistono per aiutarle a generare la documentazione potente e la parte delle vostre funzioni come autore tecnico, include la selezione dell'attrezzo di destra per il lavoro. In gran parte questo dipende dalla natura dei documenti che sono prodotti e dalla natura della loro distribuzione finale. Se i documenti possono essere trasportati usando il Internet, questo è certamente un viale da considerare. A tale scopo usi i pacchetti quali il MX dell'istantaneo e Dreamweaver per realizzare questo obiettivo. Per aiuto in linea integrato, potete desiderare generare i documenti grezzi del HTML, o selezionare alternativamente un pacchetto dell'esperto quale RoboHelp o simile. Nella cassa dei documenti basati della stampa, dovrete selezionare un pacchetto di programmi abbastanza potente per maneggiare che cosa getterete esso.
Molti autori tecnici inesperti immediatamente girano verso la parola del Microsoft (poichè è ubiquista dentro può ambienti commerciali e riservati). A meno che la vostra documentazione stia andando essere sotto 150 pagine e voi sappia generare le mascherine e fare le macro, eviti la MS parola. Poichè tutto l'autore tecnico vi dirà ha abitudini nasty tutte che debba per possedere e può spesso essere un pacchetto instabile da funzionare con. Se state generando la documentazione pesante dei grafici, potete desiderare considerare Quark Xpress, o scelga potenzialmente il capo di industria nel campo, l'adobe Framemaker. Che cosa software selezionate, dovete accertarli diventate incredibilmente competenti con esso, investendo nell'addestramento, o usando giorno dopo giorno dopo il giorno!
Comunichi che che cosa siete pagati per fare!
Molta gente vi dirà che generare la documentazione tecnica sia noiosa e ripetuta. Questa gente, è errata e possibilmente morons anche. Anche se potete trovare il processo di generazione della documentazione tecnica 'che alesa '(se fate siete nel lavoro errato!) non è. La generazione dei documenti tecnici di qualità è una fase vitale nel permettere la gente a adeguatamente e correttamente usa la tecnologia. Anche se nessun utente si avvicinerà alla documentazione che generate come si avvicina ad un romanzo, potete infine aiutarli a realizzare che cosa desiderano realizzare usando la tecnologia. Non importa come 'con acuto 'il processo può sembrare essere, permettere che gli utenti realizzino i loro obiettivi leggendo i vostri documenti dovrebbe darvi gli sbalzi di orgoglio ed effettivamente, felicità. Finchè vi ricordate degli effetti positivi che la tecnologia può avere sulle vite della gente, quando generate i vostri documenti potete comunicare più efficacemente, poichè sarete più felici nel processo comunicativo. Durante il ciclo di vita della documentazione, dovreste cercare di mantenere i contatti spesso tra i colleghe come possibile (se applicabile). Lascilo leggere i vostri documenti, ascoltare le loro critiche e registrare i vostri documenti (se non potete discutere il vostro angolo!). Un autore tecnico è pagato per comunicare, si assicura che e per non dimenticarsi mai a perchè vostro stanno comunicando ed a chi, nei documenti essi stessi.
Errori comuni da evitare di fare
Nel generare i documenti tecnici là sia un certo numero di difetti che mortali potete fare. Anche se affatto esauriente, questa sezione dettaglia alcuni degli errori che più comuni i nuovi autori fanno, nelle speranze che eviterete di farli ugualmente:
Essendo Patronising - anche se la documentazione tecnica dovrebbe essere chiara, dovrebbe non patronising mai. Non state generando i documenti da leggere dai morons ma dai consumatori e dai clienti. Dovreste scrivere sempre al livello di abilità dei vostri pubblici, ma qualunque cosa la gente livellata tecnica sia sopra, non sono morons. Anche i bambini ottengono offensivi quando patronised, non fanno quell'errore con qualcuno che stia pagando il vostro stipendio, bambino o al contrario.
Overuse di umore - la gente non legge i documenti tecnici da intrattenere, li leggono nelle speranze con successo di realizzare un processo, o di estrazione delle informazioni. A meno che sia relativo all'utilizzatore finale, eviti l'umore ove possibile. Se state scrivendo un libro, un'indennità e un buon. Se state scrivendo un manuale, eviti l'umore come la peste, poichè spesso gli utenti mancheranno lo scherzo e l'estremità giusta in su che detestano il idiot patronising che ha scritto la documentazione.
Contraddizione - anche nella fase di progettazione, dovreste accertarsi che tutti gli elementi usati nel vostro documento siano costanti. Ciò applica tanto 'al tono 'del documento quanto alla disposizione di esso. Accertivi l'uso sensi costanti (primi persona, ecc.) così come l'impaginazione, elementi di impaginazioni, intestazioni e footers e tutti gli altri elementi testuali.
Prova colta - per la fine della generazione della parte di documentazione tecnica, probabilmente sarete malato della vista di esso. Quello non importa. Che cosa importa è che cosa lascia il vostro ufficio o domestico, è esatto. A tale scopo la prova ha letto il documento durante tutti che fosse brutte copie e prima che fosse distribuita la prova la ha letta ancora ed ancora ed ancora. Non conti mai sugli ispettori di periodo (mai lavoro) e se potete evitarli, non conti mai solamente sul vostro proprio giudizio. Ottenga il vostro documento colto da altretanti accoppiamenti degli occhi come possibile prima di distribuzione, dopo tutto, potrebbero macchiare l'una cosa che avete mancati durante il processo della creazione.
Conclusione/promozione shameless di auto
La scrittura tecnica non è senza riguardo a che cosa potete pensare, un lavoro facile. Richiede la perizia, la pazienza e una miscela molto dispari delle abilità. Giusto come qualunque altro lavoro, potete imparare come a faccialo, ma neppure quelle tasse scolastiche necessariamente vi non renderanno alcuna merce esso. Essere un buon autore tecnico, dovete essere anali tuttavia creativi, messo a fuoco tuttavia comunicativo e un esperto flessibile. Ciò, come potete probabilmente immaginare, è operazione semplice. Anche se potete pensare che generando i documenti tecnici sia facile, la documentazione esatta, costante ed attuale di generazione ad un livello commerciale elevato è un ruolo altamente challenging. Senza riguardo al vostro preventivo, a lungo termine fornirà il ROI significativo se assumete un esperto. Dopo tutto, potranno fare nei giorni, che cosa strappate i vostri capelli nostro tentare di compire nei mesi di settimane se non.
Circa L'Autore
Sopra il microfono di anni Kemp è stato impiegato come un freelance ESSO giornalista (che lavorano per le pubblicazioni quali il registro, il Namesfacesplaces, il fuoco di sicurezza ed il Packetstorm), un copywriter, un progettista dei videogames, un revisore dei conti di sicurezza, un progettista di fotoricettore, un progettista grafico ed ESSO addestratore. Ha lavorato in una varietà di posizioni freelance e permanente per entrambi piccoli (per esempio due uomini ed aziende del cane) alle organizzazioni multinazionali durante sia il Regno Unito che Europa. Nel non lavorare ai vari articoli, i libri, manuali ed assorted l'altra copia per i clienti, microfono possono essere trovati solitamente lavorare duramente su una varietà di romanzi non pubblicati. Ha avuto vari dei suoi screenplays corti prodotti dalle aziende indipendenti di produzione ed attualmente sta lavorando a vari gli scritti di lunghezza della caratteristica.
Il microfono vive principalmente felicemente in un sobborgo terribile ONU-DELLA Boemia de Londra con il suo (e lungo-soffrendo) socio di lunga durata e due addled i gatti. Per imparare più circa il microfono, la gamma di progetti è stato comportato dentro e l'altri roba ed assurdità assorted, visitano prego il suo homepage personale a www.clappymonkey.com.
Fonte dell'articolo: Messaggiamo.Com
Related:
» Credit Secrets Bible» Cash Making Power Sites
» Home Cash Course
» Automated Cash Formula
Webmaster prendi il Codice Html
Aggiungi questo articolo al tuo sito ora!
Webmaster invia i tuoi Articoli
Nessuna registrazione richiesta. Compila il form e i tuoi articoli sono nella Directory di Messaggiamo.Com
