Technical Writing Essentials

Scrierea tehnică descriptivă folosește o combinație de imagini și text atât pentru a „arăta” cât și pentru a „spune” cititorului despre informația transmisă. Ca și descrierile mai creative, descrierile tehnice apelează uneori la „cele cinci simțuri” și la comparații metaforice (analogii) pentru a permite cititorului să conceptualizeze pe deplin ceea ce este descris. Cu toate acestea, cel mai adesea, ele se bazează pe descriptori concreți, măsurabili. Descrierile tehnice pot lua mai multe forme, în funcție de scop și de public. Descrierile pot varia de la o propoziție scurtă, la un paragraf, o întreagă secțiune a unui raport sau un întreg manual. Descrierile tehnice prost redactate pot provoca confuzie, pierdere de timp și chiar pot duce la o catastrofă! Deseori, descrierile tehnice ale produselor sunt obligatorii din punct de vedere legal pentru a asigura siguranța și conformitatea. Atenția la detalii este critică.

Specificațiile produselor necesită descrieri detaliate ale caracteristicilor de proiectare; instrucțiunile necesită adesea detalii descriptive specifice pentru a „arăta” cititorului ce trebuie să facă. Unele categorii generale de descrieri tehnice includ următoarele:

• Descrieri ale mecanismului: oferă o prezentare detaliată a aspectelor fizice ale unei unelte, mașini sau ale unui alt dispozitiv mecanic care are părți mobile și este proiectat pentru a îndeplini o funcție specifică. Acestea ar putea fi descrieri de produse pentru vânzări sau producție, documentarea specificațiilor de proiectare, infografice etc. Acest capitol se concentrează în detaliu pe acest tip de descriere.
• Descrieri de procese: detaliază o serie de evenimente (fenomene naturale/biologice/ecologice, mecanice, sociale sau psihologice) care se petrec într-o anumită succesiune pentru a obține un anumit rezultat. Acestea pot fi clasificate în procese non-instrucționale (cum ar fi o analiză a procesului de funcționare a unui motor cu combustie internă sau procese naturale cum ar fi fotosinteza) și procese instrucționale (cum ar fi proceduri recomandate/necesare și instrucțiuni explicite pas cu pas care trebuie urmate). (A se vedea secțiunea 7.7 pentru informații detaliate despre redactarea instrucțiunilor).
• Definiții: clarifică sensul specific, adesea legat de un context specific, sau exprimă natura esențială a termenilor care sunt definiți. Acestea pot avea o lungime variabilă, de la o simplă frază clarificatoare până la un document extins de mai multe pagini. Definițiile vor include adesea descrieri detaliate și elemente vizuale pentru a ilustra ideile. Faceți clic pe link-ul de mai jos pentru a vizualiza o prezentare PowerPoint a elevilor despre cum să scrie definiții eficiente în scopuri tehnice. Această prezentare este inclusă cu permisiunea expresă a studentului.

Definitions in Technical Writing – Exemplu de prezentare a studentului (.pdf)

Descrierile mecanismelor ar trebui să ofere o înțelegere clară a obiectului descris, inclusiv

• Aspect general și proprietăți fizice
• Funcția/scop general
• Părți componente
• Cum interacționează părțile pentru a crea un întreg funcțional.

Lectoriul ar trebui să fie capabil să-și imagineze clar și, prin urmare, să înțeleagă natura obiectului descris, ce face și cum funcționează.

Pentru a obține această claritate pentru cititor, scriitorul trebuie să aleagă detalii semnificative și să organizeze informațiile în mod logic. Selectați detalii care pot fi descrise precis și măsurabil, cum ar fi

În funcție de nevoile cititorului, descrierea poate varia de la o prezentare generală care necesită doar câteva fraze până la un manual cu mai multe capitole care detaliază fiecare aspect al pieselor și funcțiilor mecanismului pentru a rezolva problemele tehnice și a finaliza reparațiile. Pentru un exemplu amuzant al acesteia din urmă, vezi Star Trek: The Next Generation: Manualul tehnic (coperta reprezentată în figura 7.4.1), care oferă descrieri detaliate ale tuturor echipamentelor și tehnologiilor utilizate la bordul navei fictive U.S.S. Enterprise-D.

Înainte de a începe să vă redactați descrierea, trebuie să luați în considerare scopul și audiența dumneavoastră: De ce are nevoie publicul dumneavoastră de această descriere? Pentru ce o vor folosi? Descrieți diferite tipuri de panouri solare pentru consumatorii obișnuiți pentru a-i ajuta să îl aleagă pe cel care se potrivește cel mai bine nevoilor lor? Oferiți scheme tehnicienilor și instalatorilor?

După ce v-ați stabilit clar scopul și audiența, redactați o descriere care să includă următoarele elemente:

1. Definiție: Ce este și care este scopul său principal?
2. Prezentare generală: Descrieți aspectul general al mecanismului („imaginea de ansamblu”).
3. Componente: Descrieți principalele părți componente în secțiuni etichetate; luați în considerare cu atenție ordinea informațiilor aici. Creați o legătură logică între fiecare componentă descrisă.
4. Explicație: Cum lucrează piesele împreună pentru a îndeplini funcția sa? Ce principii cheie guvernează funcționarea sa? Luați în considerare cât de multe detalii sunt necesare aici pentru publicul căruia vă adresați.
5. Elemente vizuale: includeți grafice care ilustrează clar mecanismul și/sau părțile sale. Arătați dispozitivul ca întreg; luați în considerare prezentarea detaliilor specifice în vederi extinse, tăieturi sau diagrame etichetate. Puteți chiar să încorporați sau să creați un link către videoclipuri care arată dispozitivul în acțiune.
6. Concluzie: în funcție de scop, puteți trece în revistă istoricul produsului, disponibilitatea, fabricarea, costurile, avertismentele etc.)
7. Referințe: Sursele pe care le-ați utilizat în descriere sau surse suplimentare de informații disponibile (dacă este relevant).

Ați putea lua în considerare utilizarea unui șablon, cum ar fi Modelul de descriere tehnică de mai jos, ținând cont de faptul că, deși șabloanele pot fi ghiduri utile, acestea nu oferă multă flexibilitate și este posibil să nu funcționeze pentru toate situațiile.

Eșantioane de descrieri

Examinați descrierea „Up Goer Five” din figura 7.4.2 (faceți clic pe imagine pentru o versiune mai mare). Cine ar putea fi publicul vizat?

Comparați descrierea din figura 7.4.2 cu informațiile oferite pe site-ul NASA despre Mars Curiosity Rover.

Rețineți diferențele în ceea ce privește nivelul de detaliu, vocabularul și scopul general al descrierilor. Dacă ați folosi informațiile de pe site-ul NASA pentru a completa șablonul de descriere tehnică, ați putea ajunge la ceva asemănător cu următorul grafic. Obiective

S-ar putea să considerați că unele dintre aceste elemente nu sunt necesare; din nou, luați în considerare ceea ce publicul dvs. țintă știe deja. Găsiți un echilibru între a afirma inutil ceea ce este evident și a presupune în mod incorect că cititorii dvs. au cunoștințe pe care nu le au.

În rafinarea detaliilor descrierii dvs. și a părților sale componente, luați în considerare următoarele:

• Organizare: Folosiți un principiu logic pentru a vă organiza descrierea
  • De sus în jos (sau de la fundație în sus)
  • De la stânga la dreapta (sau de la dreapta la stânga)
  • De la interior la exterior (sau de la exterior la interior)
  • De la caracteristicile cele mai importante la cele mai puțin importante
  • De la componenta centrală la cele periferice
  • Proprietățile materialelor, etc.
• Limbajul: Folosiți termeni specifici, preciși, concreți – evitați termenii vagi sau prea generali
  • Utilizați o terminologie corectă – definiți termenii după cum este necesar pentru publicul dumneavoastră
  • Utilizați analogia pentru a descrie un lucru necunoscut în termenii unui lucru familiar
  • Utilizați un limbaj obiectiv – nu folosiți termeni „ad speak” sau subiectivi
  • Utilizați timpul prezent, verbe active la timpul prezent pentru a descrie cum apare dispozitivul și ce face acesta
  • Utilizați cuvinte care creează imagini vii și specifice în mintea cititorului.

Alegeți un obiect obișnuit, de zi cu zi (cum ar fi unul dintre obiectele din figura 7.4.3) și redactați o descriere tehnică pentru un public care nu este familiarizat cu acest obiect. Începeți prin a vă imagina un public țintă și un scop, apoi încercați să completați șablonul de descriere tehnică cu informații detaliate. Folosind informațiile din șablon, redactați o scurtă descriere de 1-2 paragrafe și adăugați elemente vizuale corect subtitrate.