Devo scrivere documenti tecnici come manuali, rapporti e articoli di riviste.
Recentemente, mi ritrovo a iniziare frasi con “Questo “molte volte. Ad esempio,
Distribuisci una boa segnaletica nella posizione GPS dellancora e unaltra nella posizione GPS del telaio. Questo rende la navigazione molto più semplice.
o
I file di log saranno analizzato per le impostazioni di calibrazione e altri metadati. Questo processo può richiedere alcuni minuti per file di grandi dimensioni.
o
Se sono state inserite nuove batterie, il magnetometro deve essere ricalibrato. Questa operazione è simile alla ricalibrazione spesso richiesta quando si utilizza una bussola per smartphone.
Queste frasi vanno bene o ci sono altre costruzioni di frasi che si leggono meglio? Dovrei semplicemente accettarlo e andare avanti?
Commenti
- I documenti tecnici dovrebbero essere scritti per chiarezza, non per eleganza o stile superiore. Penso che gli esempi che hai fornito siano chiari e richiedano meno elaborazione cognitiva rispetto alle alternative. Dico attenersi a loro e andare avanti.
- Rende la navigazione molto più semplice. Questo farebbe blah. Ciò rende la navigazione insignificante. In verità, in verità vi dico che renderebbe la navigazione molto più semplice.
Risposta
Cè un netto vantaggio di continuare a fare ciò che hai fatto finora.
Questo è che la ripetizione del modello
Indica al lettore di eseguire unazione,
immediatamente seguito da
Descrizione / commento riguardante il risultato e / o il vantaggio dellazione,
riduce il carico cognitivo dei tuoi lettori “: non sono costantemente tenuti a svolgere il lavoro aggiuntivo di interpretare una varietà di formati di presentazione e strutture di frasi al fine di ordinare le istruzioni dalle descrizioni o per comprendere le loro relazioni reciproche.
Il modo in cui attualmente presenti le informazioni da leggere ers consente loro di sapere immediatamente cosa ci si aspetta da loro e perché.
Il fatto che una frase inizi con “Questo” è in realtà un segnale utile per i tuoi lettori che ciò che sta per seguire è probabilmente una descrizione o un commento riguardante unazione che hai appena chiesto loro di eseguire.
Questo aspetto della presentazione del materiale è un modo importante in cui la documentazione tecnica differisce dalla finzione letteraria.
A seconda dello stile dello scrittore di narrativa, parte del piacere di leggere la narrativa dipende sullessere sorpresi da giustapposizioni inaspettate e piccoli enigmi, alcuni dei quali vengono creati o resi più intriganti variando il modo in cui il materiale viene presentato al lettore.
Nel tuo caso, stai (o dovresti) mirare per il risultato opposto: la prevedibilità della tua presentazione e la chiarezza della comprensione dei tuoi lettori andranno di pari passo. La relativa brevità delle frasi e la ripetitività del formato nella tua documentazione riducono la possibilità di creare ambiguità involontarie.
Vale la pena sopportare in min d un motivo importante per evitare ambiguità nella documentazione tecnica: non solo è fastidioso, ma può anche essere pericoloso o dannoso se un lettore viene confuso nelleseguire unazione errata (come alimentare un circuito che non dovrebbe essere alimentato).
Commenti
- @geometrikal – È ‘ probabilmente la gelosia delle mie orecchie a punta e del mio grazioso nasino.
- Unottima risposta @Erik Kowal. Questo è il motivo per cui lho votato positivamente 🙂
Answer
Quasi ogni parola o frase può essere abusata, ma nominare un argomento (agente, “personaggio” o soggetto) in una frase e poi fare riferimento ad esso con questo nella frase successiva è un modo eccellente per aiutare i lettori attraverso un passaggio con chiarezza e facilità. È un esempio di un tipo principale di stringa di argomento , un elemento stilistico vitale della maggior parte della buona scrittura.
A volte è possibile trovare un modo migliore di esprimere la frase, di solito allungando la frase antecedente di una o più clausole; ma – specialmente quando “si tratta di materiale complesso – meno frasi lunghe può aiutare i tuoi lettori a elaborare. (Non cè niente di sbagliato in frasi lunghe ben strutturate, ma preferisco le coppie di frasi nei tuoi esempi a qualsiasi modo in cui riesco a pensare di combinarle.)
Nella narrativa con molti dialoghi, siamo spesso trovano molte occorrenze della parola detta. Non è automaticamente meglio esaminarli e provare a sostituirne molti con verbi alternativi ( gridato, borbottato, emesso ecc.). Alcune parole vengono ripetute spesso senza attirare lattenzione sulla ripetizione. Questo (!) È perché svolgono le funzioni previste in modo corretto e silenzioso.
Risposta
Tutte le frasi mi sembrano OK. Ma se vuoi eliminare il “questo” allinizio della seconda frase, puoi riscrivere un po la prima frase.
Ad esempio, invece di
schiera una boa segnaletica nella posizione GPS dellancora e unaltra nella posizione GPS del telaio. Ciò rende la navigazione molto più semplice.
write
Posizionamento di una boa di segnalazione a la posizione GPS dellancora e unaltra nella posizione GPS del frame rendono la navigazione molto più facile.
Invece di
I file di registro verranno analizzati per le impostazioni di calibrazione e altri metadati. Questo processo può richiedere alcuni minuti per file di grandi dimensioni.
write
Lanalisi dei file di registro per le impostazioni di calibrazione e altri metadati può richiedere alcuni minuti per file molto grandi.
A mio parere, il terzo esempio è probabilmente il migliore lasciato come lhai citato.
Commenti
- Come immagino tu capisca, le tue alternative cambiano il significato delle coppie di frasi originali. La prima modifica perde la funzione principale delloriginale: istruzioni per la distribuzione. La seconda modifica perde la funzione principale delloriginale: informare che si verificherà unanalisi.
- Per la prima, potresti utilizzare la voce passiva: La navigazione è resa più semplice dal processo. Non la più grande delle frasi, però. Per il secondo, che ne dici di ” File molto grandi possono richiedere alcuni minuti per questo processo “?