Műszaki dokumentumokat kell írnom, például kézikönyveket, jelentéseket és folyóiratcikkeket.
Nemrégiben azt tapasztaltam, hogy “Ez “sokszor. Például
Helyezzen el egy jelölőbóját a horgony GPS helyére, egy másikat pedig a keret GPS helyére. Ez sokkal könnyebbé teszi a navigációt.
vagy
A naplófájlok a kalibrációs beállítások és egyéb metaadatok elemzése. Ez a folyamat nagyon nagy fájlok esetén néhány percet igénybe vehet.
vagy
Ha új elemeket helyeztek be, akkor a magnetométert újra kell kalibrálni. Ez a művelet hasonló az okos telefon iránytű használatakor gyakran szükséges újrakalibráláshoz.
Rendben vannak ezek a mondatok, vagy vannak más mondatkonstrukciók, amelyek jobban olvashatók? Csak el kellene fogadnom és továbblépnem?
Megjegyzések
- A műszaki dokumentumokat az érthetőség, nem pedig az elegancia vagy a magasabb stílus érdekében kell megírni. Úgy gondolom, hogy az Ön által megadott példák világosak és kevesebb kognitív feldolgozást igényelnek, mint az alternatívák. Azt mondom, ragaszkodjon hozzájuk, és lépjen tovább.
- Sokkal könnyebbé teszi a navigációt. Ettől lenne bla. Ilyen teszi a navigációt blazzá. Bizony, bizony mondom nektek, hogy ez sokkal könnyebbé teszi a navigációt.
Válasz
Van egy egyértelmű előnye annak, hogy továbbra is azt csinálod, amit eddig tettél.
Ez a minta ismétlése
utasítsa az olvasót egy művelet végrehajtására,
azonnal követi
Leírás / megjegyzés a művelet eredményéhez és / vagy előnyéhez,
csökkenti az olvasók kognitív terhelését: nincs szükségük arra, hogy folyamatosan elvégezzék a fajták értelmezésének kiegészítő munkáját bemutató formátumokat és mondatszerkezeteket annak érdekében, hogy az utasításokat le lehessen rendezni a leírásokból, vagy megértsük a kölcsönös kapcsolataikat.
Az Ön olvasási módjának bemutatása Ez lehetővé teszi számukra, hogy azonnal megtudják, mit várnak tőlük és miért.
Az a tény, hogy egy “Ez” kezdetű mondat valóban hasznos jel az olvasók számára, hogy a követendő esemény valószínűleg egy leírás vagy megjegyzés egy olyan művelettel kapcsolatban, amelyet éppen kért tőlük.
Az anyag bemutatásának ez a szempontja az egyik fontos módja annak, hogy a műszaki dokumentáció eltér az irodalmi szépirodalomtól.
A szépirodalmi író stílusától függően a szépirodalom olvasásának örömének egy része függ váratlan egymás mellé állítással és kis rejtvényekkel lepődik meg, amelyek némelyike az anyag olvasónak történő bemutatásának megváltoztatásával jön létre vagy válik érdekesebbé.
Az Ön esetében a cél (vagy annak kell lennie) az ellenkező eredmény érdekében: előadásának kiszámíthatósága és olvasói megértésének egyértelműsége kéz a kézben jár. A dokumentációban szereplő mondatok viszonylagos rövidsége és a formátum ismétlődése csökkenti a nem szándékos kétértelműség terét.
Érdemes min d a műszaki dokumentumok kétértelműségének elkerülése egyik fontos oka: nem csak bosszantó, sőt veszélyes vagy káros is lehet, ha az olvasót összekeverik egy helytelen művelet végrehajtásával (például egy áramkör bekapcsolásával, amelyet nem szabad feszültség alá helyezni).
Megjegyzések
- @geometrikal – Ez ‘ valószínűleg féltékenység a hegyes fülemre és az aranyos kis orromra.
- Kiváló válasz @Erik Kowal. Ezért szavaztam meg 🙂
Válasz
Szinte bármelyik szó vagy kifejezés túlzottan használható, de egy téma (ügynök, “karakter” vagy tárgy) megnevezése egy mondatban, majd a következő mondatban való hivatkozás erre az kiváló módja annak, hogy az olvasóknak világosan és könnyedén segítsünk egy szöveget. Ez a topic string egyik fő típusa, amely a legtöbb jó írás létfontosságú stilisztikai eleme.
Lehetséges, hogy néha találna jobb kifejezési módot, általában úgy, hogy az előzetes mondatot egy vagy több tagmondattal meghosszabbítja; de – különösen, ha összetett anyagot kezelünk – kevesebb hosszú mondat segíthet az olvasóknak a folyamatban. (A jól felépített hosszú mondatokkal nincs semmi baj, de a példáidban szereplő mondatpárokat jobban kedvelem, mint amennyire gondolni tudok ezek kombinálására.)
A sok párbeszéddel rendelkező szépirodalomban gyakran megtalálják a mondott szó sok előfordulását. Nem automatikusan jobb ezeket átnézni, és megpróbálni sokukat alternatív igékkel helyettesíteni ( sírt, motyogott, kibocsátott stb.). Egyes szavakat gyakran ismételnek anélkül, hogy felhívnák a figyelmet az ismétlésre. Ez (!) Azért van, mert jól és csendesen látják el a tervezett funkciókat.
Válasz
Számomra az összes mondat rendben van. De ha meg akarsz szabadulni a második mondat elején található “ettől”, akkor az első mondatot kicsit átírhatod.
Például
helyett helyezzen el egy jelölőbóját a horgony GPS helyén, egy másikat pedig a horgony GPS helyén. keret. Ez sokkal könnyebbé teszi a navigációt.
írás
Egy marker bója telepítése itt: a horgony GPS helye és egy másik a keret GPS helyén sokkal könnyebbé teszi a navigációt.
A naplófájlok elemzésre kerülnek a kalibrációs beállítások és egyéb metaadatok szempontjából. Ez a folyamat nagyon nagy fájlok esetén néhány percet igénybe vehet.
írás
A naplófájlok elemzése a kalibrációs beállításokhoz és más metaadatokhoz nagyon nagy fájlok esetén néhány percet igénybe vehet.
Véleményem szerint valószínűleg a harmadik példa a legjobb balra ment, ahogy idézte.
Megjegyzések
- Mint feltételezem, észrevette, alternatívái megváltoztatják az eredeti mondatpárok jelentését. Az első módosítás elveszíti az eredeti fő funkcióját: utasítást a telepítésről. A második változtatás elveszíti az eredeti fő funkcióját: Értesítés az elemzésről.
- Az elsőnél használhatja a passzív hangot: A folyamat megkönnyíti a navigációt. Nem a legnagyobb mondat. A másodikra mit szólna a ” nagyon nagy fájlokhoz, ez a folyamat néhány percet igénybe vehet “?