Jeg er nødt til at skrive tekniske dokumenter såsom manualer, rapporter og tidsskriftartikler.
For nylig finder jeg mig selv begyndende sætninger med “This “meget af tiden. For eksempel
Implementerer en markørbøje ved ankerets GPS-placering og en anden på GPS-placeringen af rammen. Dette gør det meget lettere at navigere.
eller
Logfilerne bliver analyseret til kalibreringsindstillinger og andre metadata. Denne proces kan tage et par minutter for meget store filer.
eller
Hvis der er isat nye batterier, skal magnetometeret kalibreres igen. Denne handling svarer til den genkalibrering, der ofte kræves, når du bruger et smartkompas.
Er disse sætninger okay, eller er der andre sætningskonstruktioner, der læser bedre? Skal jeg bare acceptere det og gå videre?
Kommentarer
- Tekniske dokumenter skal skrives for klarhed, ikke elegance eller højere stil. Jeg synes, de eksempler, du har givet, er klare og kræver mindre kognitiv behandling end alternativerne. Jeg siger, hold fast ved dem og gå videre.
- Det gør navigationen meget lettere. Det ville gøre bla. Sådan gør navigationen bla. Sandelig, sandelig, jeg siger jer, at det ville gøre navigationen meget lettere.
Svar
Der er en tydelig fordel ved at fortsætte med at gøre, hvad du har gjort indtil videre.
Dette er, at gentagelsen af mønsteret
Instruer læseren om at udføre en handling,
straks efterfulgt af
Beskrivelse / kommentar vedrørende handlingens resultat og / eller fordel,
mindsker dine læsere “kognitiv belastning: de er ikke konstant forpligtet til at udføre det ekstra arbejde med at fortolke en række af præsentationsformater og sætningsstrukturer for at sortere instruktionerne fra beskrivelserne eller for at forstå deres gensidige forhold.
Den måde, du præsenterer i øjeblikket information, der skal læses erne giver dem mulighed for straks at vide, hvad der forventes af dem, og hvorfor.
Det faktum, at en sætning, der starter med “Dette”, er faktisk et nyttigt signal til dine læsere om, at det, der skal følges, sandsynligvis er en beskrivelse eller kommentar vedrørende en handling, som du lige har bedt dem om at udføre.
Dette aspekt ved præsentation af materiale er en vigtig måde, hvorpå teknisk dokumentation adskiller sig fra litterær fiktion.
Afhængigt af fiktionskribentens stil afhænger en del af glæden ved at læse fiktion over at blive overrasket med uventede sidestillinger og små gåder, hvoraf nogle er skabt eller gjort mere spændende ved at variere den måde, materialet præsenteres på for læseren.
I dit tilfælde sigter du (eller bør du) for det modsatte resultat: forudsigeligheden af din præsentation og klarheden i dine læsere “forståelse vil gå hånd i hånd. Den relative korthed af sætninger og gentagelse af format i din dokumentation reducerer muligheden for at skabe utilsigtet tvetydighed.
Det er værd at bære i min d en vigtig årsag til at undgå tvetydighed i teknisk dokumentation: det er ikke kun irriterende, det kan endda være farligt eller skadeligt, hvis en læser er forvirret i at udføre en forkert handling (såsom at aktivere et kredsløb, der ikke skal have strøm). >
Kommentarer
- @geometrikal – Det ‘ er sandsynligvis jalousi over mine spidse ører og søde lille næse.
- Et fremragende svar @Erik Kowal. Dette er grunden til, at jeg stemte for det 🙂
Svar
Næsten ethvert ord eller sætning kan bruges for meget, men At navngive et emne (agent, “karakter” eller emne) i en sætning og derefter henvise til det med dette i næste sætning er en glimrende måde at hjælpe læsere gennem en passage med klarhed og lethed. Det er et eksempel på en hovedtype af emnestreng , et vigtigt stilistisk element i mest god skrivning.
Det er muligt, at du nogle gange kunne finde en bedre formulering, normalt ved at forlænge den forudgående sætning med en eller flere klausuler, men – især når du behandler komplekst materiale – færre lange sætninger kan hjælpe dine læsere med at behandle. (Der er ikke noget galt med velstrukturerede lange sætninger, men jeg foretrækker sætningsparene i dine eksempler frem for enhver måde, jeg kan komme på at kombinere dem.)
I fiktion med en masse dialog er vi finder ofte mange forekomster af ordet sagde. Det er ikke automatisk bedre at gennemgå disse og forsøge at erstatte mange af dem med alternative verb ( græd, mumlet, udsendt osv.). Nogle ord gentages ofte uden at gøre opmærksom på gentagelse. Dette (!) Skyldes, at de udfører deres tilsigtede funktioner godt og stille.
Svar
Alle sætningerne synes at være OK for mig. Men hvis du vil slippe af med “dette” i begyndelsen af anden sætning, kan du omskrive den første sætning lidt.
For eksempel i stedet for
Implementerer en markørbøje ved ankerets GPS-placering og en anden på GPS-placeringen af ramme. Dette gør det meget lettere at navigere.
skriv
Implementering af en markørbøje ved ankerets GPS-placering og en anden ved rammens GPS-placering gør det meget lettere at navigere.
I stedet for
Logfilerne analyseres for kalibreringsindstillinger og andre metadata. Denne proces kan tage et par minutter for meget store filer.
skriv
Parsing af logfilerne til kalibreringsindstillinger og andre metadata kan tage et par minutter for meget store filer.
Efter min mening er det tredje eksempel sandsynligvis bedst venstre som du citerede det.
Kommentarer
- Som jeg formoder, at du er klar over, ændrer dine alternativer betydningen af de originale sætningspar. Din første ændring mister originalens hovedfunktion: Instruktion til implementering. Din anden ændring mister originalens hovedfunktion: At informere om, at en parsing vil forekomme.
- For den første kan du bruge den passive stemme: Navigationen gøres lettere af processen. Jeg er dog ikke den største sætning. Hvad angår den anden, hvad med ” Meget store filer kan få denne proces til at tage et par minutter “?