Trebuie să scriu documente tehnice, cum ar fi manuale, rapoarte și articole din jurnale.
Recent, mă găsesc începând propoziții cu „This „mult timp. De exemplu,
Implementați o geamandură de marker la locația GPS a ancorei și alta la locația GPS a cadrului. Acest lucru face navigarea mult mai ușoară.
sau
Fișierele jurnal vor fi analizate pentru setările de calibrare și alte metadate. Acest proces poate dura câteva minute pentru fișiere foarte mari.
sau
Dacă au fost introduse baterii noi, magnetometrul trebuie recalibrat. Această operație este similară cu recalibrarea necesară adesea atunci când se utilizează o busolă de telefon inteligent.
Sunt aceste propoziții în regulă sau există alte construcții de propoziții care citesc mai bine? Ar trebui să îl accept și să merg mai departe?
Comentarii
- Documentele tehnice trebuie scrise pentru claritate, nu pentru eleganță sau pentru un stil superior. Cred că exemplele pe care le-ați furnizat sunt clare și necesită o procesare cognitivă mai mică decât alternativele. Zic să rămâi cu ei și să mergi mai departe.
- Facilitează navigarea mult mai ușor. Asta ar face bla. Acest lucru face ca navigația să fie bla. Adevărat, adevărat, vă spun că ar face navigarea mult mai ușoară.
Răspuns
Există o avantaj distinct de a continua să faceți ceea ce ați făcut până acum.
Acesta este faptul că repetarea modelului
Indicați cititorului să efectueze o acțiune,
urmat de
Descriere / comentariu privind rezultatul și / sau beneficiul acțiunii,
diminuează încărcătura cognitivă a cititorilor: nu li se cere în mod constant să efectueze munca suplimentară de interpretare a unei varietăți de formate de prezentare și structuri de propoziții pentru a sorta instrucțiunile din descrieri sau pentru a înțelege relațiile lor reciproce.
Modul în care prezentați în prezent informațiile de citit Acestea le permit să știe imediat ce se așteaptă de la ei și de ce.
Faptul unei propoziții care începe cu „Aceasta” este de fapt un semnal util cititorilor dvs. că ceea ce urmează să urmeze este probabil o descriere sau un comentariu cu privire la o acțiune pe care tocmai i-ați cerut să o efectueze.
Acest aspect al prezentării materialului este un mod important în care documentația tehnică diferă de ficțiunea literară.
În funcție de stilul scriitorului de ficțiune, o parte din plăcerea de a citi ficțiune depinde când ești surprins de juxtapuneri neașteptate și mici puzzle-uri, dintre care unele sunt create sau făcute mai interesante prin modificarea modului în care materialul este prezentat cititorului.
În cazul tău, urmărești (sau ar trebui să urmărești) pentru rezultatul opus: predictibilitatea prezentării dvs. și claritatea înțelegerii cititorilor dvs. vor merge mână în mână. Concizia relativă a propozițiilor și repetitivitatea formatului din documentația dvs. reduc domeniul de aplicare pentru a crea ambiguitate neintenționată.
Merită purtat în min un motiv important pentru evitarea ambiguității în documentația tehnică: nu numai că este enervant, poate fi chiar periculos sau dăunător dacă cititorul este confundat în efectuarea unei acțiuni incorecte (cum ar fi alimentarea unui circuit care nu ar trebui alimentat).
Comentarii
- @geometrikal – Este ‘ probabil gelozia urechilor mele ascuțite și a nasului meu drăguț.
- Un răspuns excelent @Erik Kowal. Acesta este motivul pentru care l-am votat în sus 🙂
Răspuns
Aproape orice cuvânt sau frază poate fi folosit în exces, dar numirea unui subiect (agent, „personaj” sau subiect) într-o singură propoziție și apoi referirea acestuia cu aceasta în propoziția următoare este un mod excelent de a ajuta cititorii să treacă printr-un pasaj cu claritate și ușurință. Este un exemplu de tip principal de șir de subiecte , un element stilistic vital al scrierii cele mai bune.
Este posibil ca uneori să găsiți o modalitate mai bună de formulare, de obicei prin prelungirea propoziției antecedente cu una sau mai multe clauze; dar – mai ales când tratați materiale complexe – mai puține propoziții lungi vă poate ajuta cititorii să proceseze. (Nu există nimic în neregulă cu propozițiile lungi bine structurate, dar prefer perechile de propoziții din exemplele tale decât orice fel în care mă gândesc să le combin.)
În ficțiunea cu mult dialog, suntem găsesc adesea multe apariții ale cuvântului spus. Nu este automat mai bine să parcurgeți acestea și să încercați să le înlocuiți pe multe dintre ele cu verbe alternative ( plâns, bombănit, emis etc.). Unele cuvinte se repetă adesea fără a atrage atenția asupra repetării. Acest lucru (!) Se datorează faptului că își îndeplinesc funcțiile dorite bine și în liniște.
Răspuns
Toate propozițiile mi se par OK. Dar dacă doriți să scăpați de „acest” la începutul celei de-a doua propoziții, puteți rescrie puțin prima frază.
De exemplu, în loc de
Implementați o geamandură de marcaj la locația GPS a ancorei și alta la locația GPS a cadru. Acest lucru face navigarea mult mai ușoară.
scrie
Implementarea unei geamanduri de marcare la locația GPS a ancorei și alta la locația GPS a cadrului facilitează navigarea.
În loc de
Fișierele jurnal vor fi analizate pentru setările de calibrare și alte metadate. Acest proces poate dura câteva minute pentru fișiere foarte mari.
scrie
Analizarea fișierelor jurnal pentru setările de calibrare și alte metadate poate dura câteva minute pentru fișierele foarte mari.
În opinia mea, al treilea exemplu este probabil cel mai bun lăsat așa cum l-ați citat.
Comentarii
- După cum cred că vă dați seama, alternativele dvs. schimbă sensul perechilor de propoziții originale. Prima dvs. modificare pierde funcția principală a originalului: instruirea implementării. A doua schimbare pierde funcția principală a originalului: informarea că va avea loc o analiză.
- Pentru prima, puteți utiliza vocea pasivă: Navigarea este mai ușoară prin proces. Nu este însă cea mai mare dintre propoziții. Pentru a doua, ce zici de ” Fișierele foarte mari pot face ca acest proces să dureze câteva minute „?