Technical Writing Essentials

La scrittura tecnica descrittiva usa una combinazione di immagini e testo per “mostrare” e “raccontare” al lettore le informazioni trasmesse. Come le descrizioni più creative, le descrizioni tecniche a volte attingono ai “cinque sensi” e ai paragoni metaforici (analogie) per permettere al lettore di concettualizzare pienamente ciò che viene descritto. Più spesso, tuttavia, si basano su descrittori concreti e misurabili. Le descrizioni tecniche possono assumere molte forme, a seconda dello scopo e del pubblico. Le descrizioni possono variare da una breve frase, a un paragrafo, un’intera sezione di un rapporto o un intero manuale. Descrizioni tecniche scritte male possono causare confusione, perdere tempo e persino provocare una catastrofe! Le descrizioni tecniche dei prodotti sono spesso richieste per legge per garantire la sicurezza e la conformità. L’attenzione ai dettagli è fondamentale.

Le specifiche dei prodotti richiedono descrizioni dettagliate delle caratteristiche di progettazione; le istruzioni spesso richiedono dettagli descrittivi specifici per “mostrare” al lettore cosa fare. Alcune categorie generali di descrizioni tecniche includono le seguenti:

• Descrizioni del meccanismo: forniscono una panoramica dettagliata degli aspetti fisici di uno strumento, macchina o altro dispositivo meccanico che ha parti mobili ed è progettato per eseguire una funzione specifica. Queste potrebbero essere descrizioni di prodotti per la vendita o la produzione, documentazione di specifiche di progettazione, info-grafica, ecc. Questo capitolo si concentra in dettaglio su questo tipo di descrizione.
• Descrizioni di processo: descrivono in dettaglio una serie di eventi (fenomeno naturale/biologico/ecologico, meccanico, sociale o psicologico) che accadono in particolare sequenza per raggiungere un risultato specifico. Questi possono essere categorizzati in processi non didattici (come un’analisi di processo su come funziona un motore a combustione interna, o processi naturali come la fotosintesi) e processi didattici (come procedure raccomandate/richieste e istruzioni esplicite passo dopo passo da seguire). (Vedi Sezione 7.7 per informazioni dettagliate sulla scrittura di istruzioni).
• Definizioni: chiariscono il significato specifico, spesso legato a un contesto specifico, o esprimono la natura essenziale dei termini che vengono definiti. Queste possono variare in lunghezza da una semplice frase chiarificatrice a un documento esteso di diverse pagine. Le definizioni spesso includono descrizioni dettagliate e immagini per illustrare le idee. Clicca sul link qui sotto per vedere una presentazione PowerPoint di uno studente su come scrivere definizioni efficaci per scopi tecnici. Questa presentazione è inclusa con il permesso esplicito dello studente.

Definizioni nella scrittura tecnica – Esempio di presentazione dello studente (.pdf)

Le descrizioni dei meccanismi dovrebbero fornire una chiara comprensione dell’oggetto descritto, includendo

• Apparenza generale e proprietà fisiche
• Funzione/scopo generale
• Parti componenti
• Come le parti interagiscono per creare un insieme funzionante.

Il lettore dovrebbe essere in grado di immaginare chiaramente, e quindi capire, la natura dell’oggetto descritto, cosa fa e come funziona.

Per ottenere questa chiarezza per il lettore, lo scrittore deve scegliere dettagli significativi e organizzare le informazioni in modo logico. Selezionare dettagli che possono essere descritti in modo preciso e misurabile, come

A seconda delle esigenze del lettore, la descrizione può variare da una panoramica generale che richiede solo poche frasi a un manuale di più capitoli che descrive in dettaglio ogni aspetto delle parti e delle funzioni del meccanismo per risolvere problemi tecnici e completare le riparazioni. Per un divertente esempio di quest’ultimo, vedi il Star Trek: The Next Generation: Technical Manual (copertina raffigurata in Figura 7.4.1), che fornisce descrizioni dettagliate di tutte le attrezzature e tecnologie usate a bordo della fittizia U.S.S. Enterprise-D.

Prima di iniziare a redigere la vostra descrizione, dovete considerare il vostro scopo e il vostro pubblico: Perché il tuo pubblico ha bisogno di questa descrizione? Per cosa la useranno? State descrivendo diversi tipi di pannelli solari per i consumatori medi per aiutarli a scegliere quello che meglio si adatta alle loro esigenze? State fornendo schemi a tecnici e installatori?

Una volta che avete il vostro scopo e il pubblico chiaramente a fuoco, redigete una descrizione che include i seguenti elementi:

1. Definizione: Cos’è e qual è il suo scopo principale?
2. Panoramica: Descrivere l’aspetto generale del meccanismo (“quadro generale”).
3. Componenti: Descrivi i principali componenti in sezioni etichettate; considera attentamente l’ordine delle informazioni. Create una connessione logica tra ogni componente descritto.
4. Spiegazione: come lavorano insieme le parti per svolgere la sua funzione? Quali principi chiave governano il suo funzionamento? Considera quanti dettagli sono necessari per il tuo pubblico.
5. Immagini: includi grafici che illustrino chiaramente il meccanismo e/o le sue parti. Mostra il dispositivo nel suo insieme; considera la possibilità di mostrare dettagli specifici in viste estese, ritagli o diagrammi etichettati. Puoi anche incorporare o collegarti a video che mostrano il dispositivo in azione.
6. Conclusione: a seconda dello scopo, potresti rivedere la storia del prodotto, la disponibilità, la produzione, i costi, le avvertenze, ecc: Fonti che hai usato nella tua descrizione, o ulteriori fonti di informazioni disponibili (se rilevanti).

Potresti considerare di usare un modello, come il modello di descrizione tecnica qui sotto, tenendo presente che mentre i modelli possono essere guide utili, non forniscono molta flessibilità e potrebbero non funzionare per tutte le situazioni.

Esempio di descrizione

Esamina la descrizione dell'”Up Goer Five” nella figura 7.4.2 (clicca sull’immagine per ingrandirla). Chi potrebbe essere il pubblico a cui è destinato?

Confronta la descrizione nella Figura 7.4.2 alle informazioni fornite sul sito della NASA sul Mars Curiosity Rover.

Nota le differenze nel livello di dettaglio, nel vocabolario e nello scopo generale delle descrizioni. Se hai usato le informazioni sul sito della NASA per riempire il modello di descrizione tecnica, potresti finire con qualcosa di simile alla seguente tabella. Obiettivi

Potresti scoprire che alcuni di questi elementi non sono necessari; di nuovo, considera ciò che il tuo pubblico di riferimento già conosce. Cerca di trovare un equilibrio tra l’affermare inutilmente l’ovvio e il supporre erroneamente che i tuoi lettori abbiano conoscenze che non hanno.

Nel raffinare i dettagli della tua descrizione e le sue parti componenti, considera quanto segue:

• Organizzazione: Usa un principio logico per organizzare la tua descrizione
  • Dall’alto verso il basso (o dalle fondamenta verso l’alto)
  • Da sinistra a destra (o da destra a sinistra)
  • Dall’interno all’esterno (o dall’esterno all’interno)
  • Dalle caratteristiche più importanti a quelle meno importanti
  • Dal componente centrale alle periferiche
  • Proprietà materiali, etc.
• Linguaggio: Usa termini specifici, precisi e concreti – evita termini vaghi o troppo generali
  • Usa una terminologia corretta – definisci i termini come necessario per il tuo pubblico
  • Usa l’analogia per descrivere una cosa non familiare in termini di una cosa familiare
  • Usa un linguaggio oggettivo – niente “ad speak” o termini soggettivi
  • Usa il tempo presente, verbi attivi per descrivere come il dispositivo appare e cosa fa
  • Usa parole che creano immagini vivide e specifiche nella mente del lettore.

Scegli un oggetto comune e quotidiano (come uno degli oggetti della figura 7.4.3) e redigi una descrizione tecnica per un pubblico che non conosce l’oggetto. Iniziate immaginando un pubblico e uno scopo, e poi provate a riempire il modello di descrizione tecnica con informazioni dettagliate. Usando le informazioni nel vostro modello, redigete una breve descrizione di 1-2 paragrafi, e aggiungete immagini con didascalie adeguate.