Guida alla scrittura di un documento tecnico

Un documento tecnico dovrebbe essere chiaro , facile da capire e avere uno scopo specifico . Dovrebbe comunicare idee e conoscenze tecniche al lettore senza causare confusione . Dovrebbe essere accuratamente studiato e organizzato e supportato da riferimenti affidabili . Elementi

Gli elementi di base di un documento tecnico dovrebbero includere il titolo , il nome dell'autore e la sua appartenenza , le astratte , corpo , riconoscimenti , nomenclatura , appendici e, infine , i riferimenti .


Estratto

L'abstract ( apertura) di un documento tecnico dovrebbe essere di 400 parole o meno . Lo scopo della carta e dei punti da discutere tutto dovrebbe essere introdotto qui e classificati come sfondo , metodo , risultati e conclusioni .
Rubriche

Rubriche che seguono con precisione il vostro profilo tecnico dovrebbe logicamente dividere il documento tecnico in sezioni . Le intestazioni sono numerati , ma i punti nel corpo di ogni voce non sono .
Style

Un documento tecnico dovrebbe essere conciso e semplicemente scritto e seguire una ben organizzata , contorno . Altamente termini tecnici devono essere spiegati con le definizioni facilmente comprensibili . Illustrazioni e tabelle devono essere incluse per maggiore chiarezza visiva , ma usati con parsimonia .
Referenze

Un elenco di riferimenti originali utilizzati nella ricerca il vostro documento tecnico devono essere inclusi alla fine di l'ordine in cui sono stati prima portato nel corpo della carta.