Ik moet technische documenten schrijven zoals handleidingen, rapporten en tijdschriftartikelen.
Onlangs merk ik dat ik zinnen begin met “This “veel van de tijd. Bijvoorbeeld:
Plaats een markeringsboei op de GPS-locatie van het anker en een andere op de GPS-locatie van het frame. Dit maakt navigeren veel gemakkelijker.
of
De logbestanden worden geparseerd voor kalibratie-instellingen en andere metagegevens. Dit proces kan enkele minuten duren voor zeer grote bestanden.
of
Als er nieuwe batterijen zijn geplaatst, moet de magnetometer opnieuw worden gekalibreerd. Deze handeling is vergelijkbaar met de herkalibratie die vaak nodig is bij het gebruik van een smartphonekompas.
Zijn deze zinnen oké of zijn er andere zinconstructies die beter lezen? Moet ik het gewoon accepteren en verder gaan?
Opmerkingen
- Technische documenten moeten worden geschreven voor duidelijkheid, niet voor elegantie of hogere stijl. Ik denk dat de voorbeelden die je hebt gegeven duidelijk zijn en minder cognitieve verwerking vereisen dan de alternatieven. Ik zeg: blijf bij hen en ga verder.
- Het maakt de navigatie veel gemakkelijker. Dat zou blah zijn. Dat maakt navigatie blah. Voorwaar, voorwaar, ik zeg u dat het de navigatie veel gemakkelijker zou maken.
Antwoord
Er is een duidelijk voordeel om te blijven doen wat je tot nu toe hebt gedaan.
Dit is dat de herhaling van het patroon
Instrueer de lezer om een actie uit te voeren,
onmiddellijk gevolgd door
Beschrijving / opmerking over het resultaat en / of voordeel van de actie,
vermindert de cognitieve belasting van uw lezers: ze hoeven niet constant het aanvullende werk van het interpreteren van verschillende van presentatie-indelingen en zinsstructuren om de instructies uit de beschrijvingen te sorteren of om hun onderlinge relaties te begrijpen.
De manier waarop u momenteel informatie presenteert om te lezen ers stelt hen in staat direct te weten wat er van hen wordt verwacht en waarom.
Het feit dat een zin begint met “Dit” is eigenlijk een nuttig signaal voor je lezers dat wat er gaat volgen waarschijnlijk een beschrijving of opmerking is over een actie die je ze zojuist hebt gevraagd uit te voeren.
Dit aspect van de presentatie van materiaal is een belangrijke manier waarop technische documentatie verschilt van literaire fictie.
Afhankelijk van de stijl van de fictieschrijver, hangt een deel van het plezier van het lezen van fictie af over verrast te worden met onverwachte nevenschikkingen en kleine puzzels, waarvan sommige zijn gemaakt of intrigerend gemaakt door de manier waarop het materiaal aan de lezer wordt gepresenteerd te variëren.
In jouw geval richt (of zou je moeten zijn) voor het tegenovergestelde resultaat: de voorspelbaarheid van uw presentatie en de duidelijkheid van het begrip van uw lezers gaan hand in hand. De relatieve beknoptheid van zinnen en de herhaling van de opmaak in uw documentatie verkleinen de kans op het creëren van onbedoelde dubbelzinnigheid.
Het is de moeite waard om in min d een belangrijke reden om dubbelzinnigheid in technische documentatie te vermijden: het is niet alleen vervelend, het kan zelfs gevaarlijk of schadelijk zijn als een lezer in de war raakt door een verkeerde handeling uit te voeren (zoals het bekrachtigen van een circuit dat niet onder spanning moet staan).
Reacties
- @geometrikal – Het is ‘ s waarschijnlijk jaloezie op mijn puntige oren en schattige kleine neus.
- Een uitstekend antwoord @Erik Kowal. Dit is de reden waarom ik het heb overstemd 🙂
Antwoord
Bijna elk woord of elke zin kan te veel worden gebruikt, maar het benoemen van een onderwerp (agent, “karakter” of onderwerp) in één zin en er vervolgens naar te verwijzen met this in de volgende zin, is een uitstekende manier om lezers duidelijk en gemakkelijk door een passage te helpen. Het is een voorbeeld van een hoofdtype onderwerpstring , een essentieel stilistisch element van goed schrijven.
Het is mogelijk dat u soms een betere manier van formuleren kunt vinden, meestal door de voorafgaande zin te verlengen met een of meer clausules; maar – vooral als u ingewikkeld materiaal behandelt – minder lange zinnen kan uw lezers helpen bij het proces. (Er is niets mis met goed gestructureerde lange zinnen, maar ik geef de voorkeur aan de zinparen in uw voorbeelden boven elke manier waarop ik ze kan combineren.)
In fictie met veel dialoog zijn we vinden vaak veel gevallen van het woord said. Het is niet automatisch beter om deze door te nemen en te proberen veel ervan te vervangen door alternatieve werkwoorden ( huilde, mompelde, uitgezonden enz.). Sommige woorden worden vaak herhaald zonder de aandacht op herhaling te vestigen. Dit (!) Komt doordat ze de beoogde functies goed en stil uitvoeren.
Antwoord
Alle zinnen lijken mij in orde. Maar als u het “dit” aan het begin van de tweede zin wilt verwijderen, kunt u de eerste zin een beetje herschrijven.
Bijvoorbeeld, in plaats van
Plaats een markeringsboei op de GPS-locatie van het anker en een andere op de GPS-locatie van de kader. Dit maakt navigeren veel gemakkelijker.
schrijven
Eén markeringsboei plaatsen bij de GPS-locatie van het anker, en een andere op de GPS-locatie van het frame, maakt navigeren veel gemakkelijker.
In plaats van
De logbestanden worden geparseerd voor kalibratie-instellingen en andere metadata. Dit proces kan enkele minuten duren voor zeer grote bestanden.
schrijven
Het parseren van de logbestanden voor kalibratie-instellingen en andere metadata kan enkele minuten duren voor zeer grote bestanden.
Naar mijn mening is het derde voorbeeld waarschijnlijk het beste links zoals je het citeerde.
Opmerkingen
- Zoals je vermoedt, veranderen je alternatieven de betekenis van de oorspronkelijke zinparen. Uw eerste wijziging verliest de hoofdfunctie van het origineel: instrueren om te implementeren. Uw tweede wijziging verliest de hoofdfunctie van het origineel: informeren dat er een parsering zal plaatsvinden.
- Voor de eerste zou u de passieve stem kunnen gebruiken: Navigatie wordt gemakkelijker gemaakt door het proces. Maar niet de grootste zinnen. Voor de tweede, wat dacht je van ” Zeer grote bestanden kunnen ervoor zorgen dat dit proces een paar minuten duurt “?