Jeg må skrive tekniske dokumenter som manualer, rapporter og journalartikler.
Nylig har jeg funnet meg selv begynnende setninger med «This » mye av tiden. For eksempel
Distribuer en markørbøye ved ankerets GPS-plassering og en annen på GPS-plasseringen av rammen. Dette gjør det enklere å navigere.
eller
Loggfilene blir analysert for kalibreringsinnstillinger og andre metadata. Denne prosessen kan ta noen minutter for veldig store filer.
eller
Hvis nye batterier er satt inn, må magnetometeret kalibreres på nytt. Denne operasjonen ligner på den kalibreringen som ofte kreves når du bruker et smartkompass.
Er disse setningene i orden, eller er det noen andre setningskonstruksjoner som leser bedre? Skal jeg bare godta det og gå videre?
Kommentarer
- Tekniske dokumenter skal skrives for klarhet, ikke eleganse eller høyere stil. Jeg tror eksemplene du ga er klare, og krever mindre kognitiv behandling enn alternativene. Jeg sier hold deg til dem og gå videre.
- Det gjør navigering mye enklere. Det ville gjøre bla. Slikt gjør navigasjonen bla. Sannelig, sannelig sier jeg deg at det ville gjøre navigasjonen mye enklere.
Svar
Det er en tydelig fordel ved å fortsette å gjøre det du har gjort hittil.
Dette er at repetisjonen av mønsteret
Be leseren om å utføre en handling,
umiddelbart etterfulgt av
Beskrivelse / kommentar angående handlingens resultat og / eller fordel,
reduserer lesernes kognitive belastning: de blir ikke stadig krevd å utføre det ekstra arbeidet med å tolke en rekke presentasjonsformater og setningsstrukturer for å sortere instruksjonene fra beskrivelsene, eller for å forstå deres gjensidige forhold.
Måten du presenterer informasjon for å lese ers gjør det mulig for dem å vite umiddelbart hva som forventes av dem, og hvorfor.
Faktumet med en setning som begynner med «Dette» er faktisk et nyttig signal til leserne om at det som er i ferd med å følge, sannsynligvis er en beskrivelse eller kommentar angående en handling du nettopp har bedt dem utføre.
Dette aspektet av presentasjonen av materiale er en viktig måte som teknisk dokumentasjon skiller seg fra litteraturfiksjon.
Avhengig av stilen til skjønnlitterær forfatter, avhenger en del av gleden av å lese skjønnlitteratur på å bli overrasket med uventede sidestillinger og små gåter, hvorav noen blir skapt eller gjort mer spennende ved å variere måten materialet blir presentert for leseren.
I ditt tilfelle sikter du (eller burde du) for det motsatte resultatet: Forutsigbarheten til presentasjonen din og klarheten til lesernes forståelse vil gå hånd i hånd. Den relative korte setningen og formatets repetisjonsevne i dokumentasjonen din reduserer muligheten for å skape utilsiktet tvetydighet.
Det er verdt å bære i min d en viktig grunn til å unngå tvetydighet i teknisk dokumentasjon: ikke bare er det irriterende, det kan til og med være farlig eller ødeleggende hvis en leser er forvirret til å utføre en feil handling (for eksempel å aktivere en krets som ikke skal få strøm).
Kommentarer
- @geometrikal – Det ' er sannsynligvis sjalu på mine spisse ører og søte lille nese.
- Et utmerket svar @Erik Kowal. Dette er grunnen til at jeg oppstemte det 🙂
Svar
Nesten ethvert ord eller uttrykk kan brukes for mye, men å navngi et emne (agent, «karakter» eller emne) i en setning og deretter henvise til det med dette i neste setning er en utmerket måte å hjelpe leserne gjennom et avsnitt med klarhet og letthet. Det er et eksempel på en hovedtype av emnestreng , et viktig stilistisk element i mest god skriving.
Det er mulig at du noen ganger kan finne en bedre formulering, vanligvis ved å forlenge den forutgående setningen med en eller flere ledd, men – spesielt når du behandler komplekst materiale – færre lange setninger kan hjelpe leserne dine med å behandle. (Det er ingenting galt med velstrukturerte lange setninger, men jeg foretrekker setningsparene i eksemplene dine på noen måte jeg kan tenke meg å kombinere dem.)
I fiksjon med mye dialog er vi finner ofte mange forekomster av ordet sa. Det er ikke automatisk bedre å gå gjennom disse og prøve å erstatte mange av dem med alternative verb ( gråt, mumlet, emitterte etc.). Noen ord gjentas ofte uten å gjøre oppmerksom på gjentakelse. Dette (!) Er fordi de utfører sine tiltenkte funksjoner godt og stille.
Svar
Alle setningene virker OK for meg. Men hvis du vil bli kvitt «dette» i begynnelsen av andre setning, kan du omskrive den første setningen litt.
For eksempel, i stedet for
Distribuer en markørbøye ved ankerets GPS-plassering og en annen på GPS-plasseringen til ramme. Dette gjør det enklere å navigere.
skriv
Implementering av en markørbøye ved GPS-posisjonen til ankeret, og en annen på GPS-posisjonen til rammen gjør navigering mye enklere.
I stedet for
Loggfilene blir analysert for kalibreringsinnstillinger og andre metadata. Denne prosessen kan ta noen minutter for veldig store filer.
skriv
Parsing av loggfilene for kalibreringsinnstillinger og andre metadata kan ta noen minutter for veldig store filer.
Etter min mening er nok det tredje eksemplet best igjen som du siterte det.
Kommentarer
- Som jeg antar at du skjønner, endrer alternativene dine betydningen av de originale setningsparene. Din første endring mister originalfunksjonens hovedfunksjon: Instruere å distribuere. Din andre endring mister originalfunksjonens hovedfunksjon: Å informere om at en parsing vil skje.
- For den første kan du bruke passiv stemme: Navigering blir enklere av prosessen. Ikke den største setningen, skjønt. For den andre, hva med " Svært store filer kan gjøre at denne prosessen tar noen minutter "?