Jag måste skriva tekniska dokument som manualer, rapporter och tidskriftsartiklar.
Nyligen har jag börjat meningar med ”This ” ofta. Till exempel
Distribuera en markörboj vid ankarets GPS-plats och en annan på GPS-platsen för ramen. Detta gör det lättare att navigera.
eller
Loggfilerna kommer att analyseras för kalibreringsinställningar och andra metadata. Denna process kan ta några minuter för mycket stora filer.
eller
Om nya batterier har satts i måste magnetometern kalibreras om. Den här åtgärden liknar den omkalibrering som ofta krävs när du använder en smartkompass.
Är de här meningarna okej eller finns det några andra meningskonstruktioner som läser bättre? Ska jag bara acceptera det och gå vidare?
Kommentarer
- Tekniska dokument bör skrivas för tydlighet, inte elegans eller högre stil. Jag tror att exemplen du gav är tydliga och kräver mindre kognitiv bearbetning än alternativen. Jag säger hålla fast vid dem och gå vidare.
- Det gör navigering mycket lättare. Det skulle göra bla. Sådan gör navigering bla. Sannerligen, sannerligen säger jag er att det skulle göra navigering mycket lättare.
Svar
Det finns en tydlig fördel med att fortsätta göra det du har gjort hittills.
Detta är att repetitionen av mönstret
Be läsaren att utföra en åtgärd,
omedelbart följt av
Beskrivning / kommentar angående åtgärdens resultat och / eller fördel,
minskar dina läsares kognitiva belastning: de behöver inte ständigt utföra det extra arbetet med att tolka en variation av presentationsformat och meningsstrukturer för att sortera instruktionerna från beskrivningarna eller för att förstå deras ömsesidiga förhållanden.
Hur du för närvarande presenterar information att läsa ger dem möjlighet att omedelbart veta vad som förväntas av dem och varför.
Att en mening som börjar med ”Detta” är faktiskt en användbar signal för dina läsare att det som är på väg att följa troligen är en beskrivning eller kommentar angående en åtgärd som du just har bett dem att utföra.
Denna aspekt av presentationen av material är ett viktigt sätt på vilket teknisk dokumentation skiljer sig från litterär fiktion.
Beroende på fiktionens författares stil beror en del av nöjet att läsa fiktion över att bli förvånad över oväntade sidopositioner och små pussel, varav några skapas eller blir mer spännande genom att variera hur materialet presenteras för läsaren.
I ditt fall siktar du (eller borde du) för motsatt resultat: förutsägbarheten för din presentation och tydligheten i dina läsares ”förståelse kommer att gå hand i hand. Den relativa kortfattningen av meningar och upprepning av formatet i din dokumentation minskar möjligheten att skapa oavsiktlig tvetydighet.
Det är värt att bära i min d en viktig anledning för att undvika tvetydighet i teknisk dokumentation: det är inte bara irriterande, det kan till och med vara farligt eller skadligt om en läsare är förvirrad att utföra en felaktig åtgärd (till exempel att aktivera en krets som inte borde få ström). >
Kommentarer
- @geometrikal – Det ' är förmodligen svartsjuka på mina spetsiga öron och söt liten näsa.
- Ett utmärkt svar @Erik Kowal. Det är därför jag röstade upp det 🙂
Svar
Nästan alla ord eller fraser kan överanvändas, men Att namnge ett ämne (agent, ”karaktär” eller ämne) i en mening och sedan hänvisa till det med detta i nästa mening är ett utmärkt sätt att hjälpa läsare genom en passage med tydlighet och lätthet. Det är ett exempel på en huvudtyp av ämnessträng , en viktig stilistisk del av mest bra skrivande.
Det är möjligt att du ibland kan hitta ett bättre sätt att formulera, vanligtvis genom att förlänga den tidigare meningen med en eller flera klausuler, men – särskilt när du behandlar komplext material – färre långa meningar kan hjälpa dina läsare att bearbeta. (Det är inget fel med välstrukturerade långa meningar, men jag föredrar meningsparen i dina exempel framför vad jag kan tänka mig att kombinera dem.)
I fiktion med mycket dialog är vi hittar ofta många förekomster av ordet sagt. Det är inte automatiskt bättre att gå igenom dessa och försöka ersätta många av dem med alternativa verb ( grät, mumlade, emitterade etc.). Vissa ord upprepas ofta utan att uppmärksamma repetitionen. Detta (!) Beror på att de utför sina avsedda funktioner bra och tyst.
Svar
Alla meningar verkar OK för mig. Men om du vill bli av med ”detta” i början av andra meningen kan du skriva om den första meningen lite.
Till exempel, istället för
Distribuera en markörboj vid ankarets GPS-plats och en annan vid GPS-platsen för ram. Detta gör det mycket lättare att navigera.
skriv
Distribuera en markörboj vid ankarets GPS-position och en annan vid ramens GPS-position gör det lättare att navigera.
Istället för
Loggfilerna analyseras för kalibreringsinställningar och andra metadata. Denna process kan ta några minuter för mycket stora filer.
skriv
Att analysera loggfilerna för kalibreringsinställningar och andra metadata kan ta några minuter för mycket stora filer.
Enligt min mening är det tredje exemplet troligen bäst lämnat som du citerade det.
Kommentarer
- Som jag antar att du inser ändrar dina alternativ betydelsen av de ursprungliga meningsparen. Din första ändring förlorar originalets huvudfunktion: Instruktion att distribuera. Din andra ändring förlorar originalets huvudfunktion: Att informera att en tolkning kommer att ske.
- För den första kan du använda den passiva rösten: Navigationen underlättas av processen. Jag är dock inte den största meningen. För den andra, hur är det med " Mycket stora filer kan göra att processen tar några minuter "?