Musím psát technické dokumenty, jako jsou manuály, zprávy a články v časopisech.
Nedávno začínám věty s „This “ hodně času. Například
Umístěte jednu bójku s markerem do polohy GPS kotvy a další do polohy GPS rámu. Tím je navigace mnohem jednodušší.
nebo
Soubory protokolu budou analyzováno pro nastavení kalibrace a další metadata. U velmi velkých souborů může tento proces trvat několik minut.
nebo
Pokud byly vloženy nové baterie, musí být magnetometr překalibrován. Tato operace je podobná rekalibraci, která se často vyžaduje při použití kompasu chytrého telefonu.
Jsou tyto věty v pořádku, nebo existují nějaké jiné věty, které jsou lepší? Měl bych to jen přijmout a jít dál?
Komentáře
- Technické dokumenty by měly být psány pro přehlednost, nikoli pro eleganci nebo vyšší styl. Myslím, že příklady, které jste poskytli, jsou jasné a vyžadují méně kognitivního zpracování než alternativy. Říkám, držte se jich a pokračujte.
- Usnadňuje to navigaci. To by bylo bla. Díky tomu je navigace bla. Vpravdě, vpravdě, říkám vám, že by to mnohem usnadnilo navigaci.
Odpověď
Existuje zřetelnou výhodou pokračování v tom, co jste dělali doposud.
Je to tak, že opakování vzoru
Požádejte čtenáře, aby okamžitě provedl akci,
následuje
Popis / komentář týkající se výsledku a / nebo přínosu akce,
snižuje kognitivní zátěž vašich čtenářů: není od nich neustále vyžadováno, aby prováděli další práci při interpretaci rozmanitosti prezentačních formátů a větných struktur, aby bylo možné třídit pokyny od popisů nebo porozumět jejich vzájemným vztahům.
Způsob, jakým aktuálně prezentujete informace ke čtení umožňuje jim okamžitě vědět, co se od nich očekává a proč.
Skutečnost, že věta začínající na „This“ je ve skutečnosti užitečným signálem pro vaše čtenáře, že se chystají následovat, je pravděpodobně popis nebo komentář týkající se akce, kterou jste právě požádali o provedení.
Tento aspekt prezentace materiálu je jedním z důležitých způsobů, kterými se technická dokumentace liší od literární fikce.
V závislosti na stylu spisovatele beletrie závisí část potěšení ze čtení beletrie o překvapení neočekávanými vzájemnými protiklady a malými hádankami, z nichž některé jsou vytvářeny nebo vytvářeny zajímavějšími změnami způsobu, jakým je materiál předkládán čtenáři.
Ve vašem případě se snažíte (nebo byste měli) pro opačný výsledek: předvídatelnost vaší prezentace a jasnost porozumění vašim čtenářům půjde ruku v ruce. Relativní stručnost vět a opakovatelnost formátu ve vaší dokumentaci snižují prostor pro vytváření neúmyslné nejednoznačnosti.
Stojí za to nést min d jeden důležitý důvod, jak se vyhnout nejednoznačnosti v technické dokumentaci: nejenže je to otravné, může to být dokonce nebezpečné nebo škodlivé, pokud je čtenář zmaten v provedení nesprávné akce (například zapnutí obvodu, který by neměl být napájen).
Komentáře
- @geometrikal – ' to pravděpodobně žárlí na moje špičaté uši a roztomilý malý nos.
- Vynikající odpověď @Erik Kowal. Z tohoto důvodu jsem hlasoval pro: 🙂
Odpověď
Téměř každé slovo nebo frázi lze nadužívat, ale pojmenování tématu (agenta, „postavy“ nebo předmětu) v jedné větě a jeho následné odkazování na toto v následující větě je vynikající způsob, jak pomoci čtenářům v úryvku s jasností a lehkostí. Jedná se o příklad hlavního typu tematického řetězce , důležitého stylistického prvku nejvhodnějšího psaní.
Je možné, že byste někdy mohli najít lepší způsob frázování, obvykle prodloužením předcházející věty o jednu nebo více vět, ale – zvláště když zpracováváte složitý materiál – méně zdlouhavých vět může vašim čtenářům pomoci zpracovat. (S dobře strukturovanými dlouhými větami se nestalo nic špatného, ale ve vašich příkladech dávám přednost větným párům před jakýmkoli způsobem, který mě napadne kombinovat.)
Ve fikci se spoustou dialogů jsme často najdete mnoho výskytů slova řekl. Není automaticky lepší projít si tyto a pokusit se nahradit mnoho z nich alternativními slovesy ( plakala, mumlala, vydávala atd.). Některá slova se často opakují bez upozornění na opakování. Důvodem je (!), Že vykonávají své zamýšlené funkce dobře a tiše.
Odpověď
Všechny věty se mi zdají v pořádku. Pokud se ale chcete zbavit „tohoto“ na začátku druhé věty, můžete první větu trochu přepsat.
Například místo
Umístěte jednu bójku s markerem do polohy GPS kotvy a další do polohy GPS rám. Tím je navigace mnohem jednodušší.
napsat
Nasazení jedné značkovací bóje na GPS poloha kotvy a další v GPS poloze rámu usnadňuje navigaci.
Místo
Soubory protokolu budou analyzovány pro nastavení kalibrace a další metadata. Tento proces může u velmi velkých souborů trvat několik minut.
napsat
Analýza souborů protokolu pro nastavení kalibrace a dalších metadat může u velmi velkých souborů trvat několik minut.
Podle mého názoru je třetí příklad pravděpodobně nejlepší odešel, jak jste ho citoval.
Komentáře
- Jak si asi uvědomujete, vaše alternativy mění význam původních párů vět. Vaše první změna ztratí hlavní funkci originálu: Pokyny k nasazení. Vaše druhá změna ztratí hlavní funkci originálu: Informovat, že dojde k analýze.
- U první můžete použít pasivní hlas: Proces usnadňuje navigaci. Není to ale největší z vět. U druhého, co třeba " Díky velmi velkým souborům může tento proces trvat několik minut "?