Specifiche
Guida di riferimento
(nota: Poiché le specifiche variano così ampiamente conforme all'oggetto, tutta la seguente guida di riferimento non si applicherà in ogni caso.)
Prenda la cura con i presupposti circa conoscenza dei vostri lettori. Quasi sempre con le specifiche, scriverete per più di un lettore. Conosca la loro priorità bassa, conoscenza e familiarità recente con il vostro oggetto. Quando in dubbio, spieghi.
Descrizione gli obiettivi di un processo, di un progetto, o di un'apparecchiatura prima di cominciare i particolari specifici.
Provi a segnare e brevemente dichiarare il numero con esattezza di fasi, di punti, o di componenti nel processo, nell'istruzione, o nella descrizione. Tali guasti rendono l'intero oggetto più comprensibile.
Nella descrizione dell'apparecchiatura, cominci con le parti interne e muovasi verso l'esterno o viceversa, quale disposizione sembra più logica. Tuttavia, non si muova avanti e indietro fra le due disposizioni del particolare.
Definisca i concetti non pratici la prima volta li usate. Come sapete in un campo tecnico che i termini sono non pratici? Di nuovo, conoscere i vostri pubblici è essenziale. In generale, è sempre migliore dare una definizione "inutile" che omettere necessario.
Usi le abbreviazioni per tagliare la lunghezza di parola, ma che assicurisi che sono standard e ben note.
Accenni prominente tutte le misure di sicurezza e ripeti ancora prima del punto o sezioni in quale la precauzione dovrebbe essere presa.
Dia i punti nell'ordine cronologico. Indichi ogni punto in una frase separata. Altrimenti, i punti possono essere capiti come azioni simultanee piuttosto che separate, sequenziali.
Le istruzioni "write" nell'umore imperativo: "controlli queste bussole per..." piuttosto che "queste bussole dovrebbero essere controllate per..."; "riguardi le superfici d'intestatura dell'estremità di materiale approvato di sealing" piuttosto che "le superfici d'intestatura dell'estremità saranno coperte di materiale approvato di sealing."
Faccia il complemento delle illustrazioni e del testo, piuttosto che il duplicato. Per esempio, potete dire a in testo come morsetti del tubo su un montaggio di riduzione e date le dimensioni del tubo in un'illustrazione. Il problema nel ripetere le informazioni in due posti è duplice: 1) l'illustrazione o il testo può essere cambiato ad alcuno data ulteriore senza accompagnare i cambiamenti nell'altro documento, così con conseguente particolari contradittori; 2) le stesse informazioni possono essere ripetute così per "chiarificazione," con conseguente due interpretazioni separate. Se dovete ripetere le informazioni in due posti, assicurisi che il vostro wording è una ripetizione esatta.
Disponga la tabella di sostegno, gli abbozzi, le tabelle, le fotografie, o le liste come vicino alla loro menzione nel testo come possibile.
Usi i numeri anziché i numeri scritti.
Dia i generi, i codici categoria, o i gradi di materiali in un modo che permessi voi essere specifico per tutte le situazioni. A fare questo, cominci con le eccezioni ed allora il grumo "nelle categorie di tutto il resto". Per esempio: Tubo: 3/8 di pollice per i lavabi e le fontani dell'acqua; pollice di 1/2 per tutti i sistemi di spruzzatore; 3/4 di pollice per tutte le altre linee di galleggiamento.
Rompa lungamente in su i blocchi di testo. Usi la frequente sezione o divida i titoli in paragrafi; usi le liste; o le parole o le frasi chiave messe nelle lettere maiuscole, italicize loro, o le sottolineano. Questi sussidi permettono che il vostro lettore scremi come con un manuale di riferimento o un documento giuridico senza grandi blocchetti della lettura di testo. Evidenzi i particolari significativi disponendoli da solo in un paragrafo separato e corto.
Non includa "portata una sezione del lavoro". La relativa imprecisione usuale la rende insignificante e pericolosa. Come altre introduzioni, "la portata sezioni del lavoro" tende ad essere riempiendo che dice semplicemente, "più successivamente io sto andando dirvi qualche cosa di importante e specifico." Queste sezioni possono essere pericolose: I lettori possono gettare uno sguardo alla sezione pensando che hanno l'immagine intera ed il ritrovamento successivo "minore" sorprese l'affioramento nelle sezioni dettagliate. Quando "la portata sezioni del lavoro" è al loro la cosa migliore -- specifico -- diventano ridondanti.
Non usi le clausole tutto-comprendenti del fermo come quanto segue: "l'azienda completerà ed includerà tutto per il funzionamento completo del sistema con tutto il lavoro conforme ad approvazione dai nostri assistenti tecnici." Aprasi solitamente a molte interpretazioni, tale media di osservazioni, "congettura che cosa può risultare successivamente quello che li desidero fare."
Non aggiunga "ecc." all'estremità di una lista. Ciò suggerisce che il produttore non conosce che cosa la lista consiste o è troppo pigra per rifinire della scrittura. "ecc." soltanto domande di aumenti.
