Minun täytyy kirjoittaa teknisiä asiakirjoja, kuten käsikirjoja, raportteja ja päiväkirjaartikkeleita.
Viime aikoina huomaan olevani aloittamassa lauseita ”Tämä ” paljon aikaa. Esimerkiksi
Asenna yksi merkintäpoiju ankkurin GPS-sijaintiin ja toinen kehyksen GPS-sijaintiin. Tämä tekee navigoinnista paljon helpompaa.
tai
Lokitiedostot jäsennelty kalibrointiasetuksia ja muita metatietoja varten. Tämä prosessi voi viedä muutaman minuutin erittäin suurille tiedostoille.
tai
Jos laitteeseen on asetettu uusia paristoja, magnetometri on kalibroitava uudelleen. Tämä toiminto muistuttaa kalibrointia, jota usein vaaditaan älypuhelinkompassia käytettäessä.
Ovatko nämä lauseet kunnossa vai onko muita lauseenrakenteita, jotka lukevat paremmin? Pitäisikö minun vain hyväksyä se ja siirtyä eteenpäin?
Kommentit
- Tekniset asiakirjat tulisi kirjoittaa selkeyden, ei tyylikkyyden tai korkeamman tyylin vuoksi. Mielestäni antamasi esimerkit ovat selkeitä ja vaativat vähemmän kognitiivista käsittelyä kuin vaihtoehdot. Sanon pysyä heidän kanssaan ja siirtyä eteenpäin.
- Se helpottaa navigointia. Se tekisi blah. Tällainen tekee navigoinnista blah. Totisesti, totisesti sanon teille, että se helpottaisi navigointia paljon.
Vastaa
On olemassa selvä etu jatkaa tekemistäsi tähän mennessä tekemäsi kanssa.
Tämä on se, että mallin toistaminen
Kehota lukijaa suorittamaan toiminto,
välittömästi jota seuraa
Kuvaus / kommentti toiminnan tuloksesta ja / tai hyödystä,
vähentää lukijasi kognitiivista kuormitusta: heidän ei tarvitse jatkuvasti suorittaa lisätyötä lajikkeen tulkinnassa esitysmuotoja ja lauseen rakenteita, jotta voit lajitella ohjeet kuvauksista tai ymmärtää niiden keskinäiset suhteet.
Tapa, jolla esität tällä hetkellä tietoa luettavaksi avulla he voivat heti tietää, mitä heiltä odotetaan ja miksi.
”Tämä” -alkuisen lauseen tosiasia on itse asiassa hyödyllinen signaali lukijoille, että seuraava on todennäköisesti kuvaus tai kommentti toiminnosta, jonka olet juuri pyytänyt heitä suorittamaan.
Tämä aineiston esittelyn näkökohta on tärkeä tapa erottaa tekninen dokumentaatio kirjallisuudesta.
Osa kaunokirjallisuuden kirjoittajan tyylistä riippuu kaunokirjallisuuden lukemisesta. yllättyä odottamattomilla vastakkainasettelulla ja pienillä pulmilla, joista jotkut luodaan tai tehdään kiehtovammiksi vaihtelemalla materiaalin esitystapaa lukijalle.
Sinun tapauksessasi olet (tai sinun pitäisi olla) tähtääminen päinvastaiseen tulokseen: esityksen ennustettavuus ja lukijoiden ymmärryksen selkeys kulkevat käsi kädessä. Lausekkeiden suhteellinen lyhyys ja asiakirjojen muodon toistuvuus vähentävät tahattomien epäselvyyksien syntymismahdollisuuksia.
Se kannattaa kantaa min d yksi tärkeä syy teknisen dokumentaation epäselvyyksien välttämiselle: se ei ole vain ärsyttävää, se voi olla jopa vaarallista tai vahingollista, jos lukija sekoitetaan suorittamaan virheellinen toimenpide (esimerkiksi virtapiiri, jota ei pitäisi virrata).
Kommentit
- @geometrikal – Se ’ on luultavasti mustasukkainen teräville korville ja söpölle pienelle nenälle.
- Erinomainen vastaus @Erik Kowal. Siksi äänestin sitä 🙂
Vastaus
Lähes mitä tahansa sanaa tai ilmausta voidaan käyttää liikaa, mutta aiheen (agentti, ”hahmo” tai aihe) nimeäminen yhdellä lauseella ja viittaaminen sitten tähän seuraavassa lauseessa on erinomainen tapa auttaa lukijoita selvyyden ja helpon osan kautta. Se on esimerkki aihejonosta , joka on keskeinen tyylinen osa useimpia hyviä kirjoituksia.
On mahdollista, että joskus voit löytää paremman tavan muotoilla sanoja, yleensä pidentämällä ennakkotapausta yhdellä tai useammalla lauseella; mutta – varsinkin kun käsittelet monimutkaista materiaalia – vähemmän pitkiä lauseita voi auttaa lukijaasi prosessoimaan. (Hyvin jäsennellyissä pitkissä lauseissa ei ole mitään vikaa, mutta pidän parempana esimerkkiesi lauseparia kuin mitä tahansa niiden yhdistämistä voi ajatella.)
Fiktiossa, jossa on paljon vuoropuhelua, olemme usein löytää monia sanan sanottu esiintymiä. Ei ole automaattisesti parempi käydä läpi nämä ja yrittää korvata monet niistä vaihtoehtoisilla verbeillä ( itkeä, mölynää, päästetty jne.). Joitakin sanoja toistetaan usein huomauttamatta toistamista. Tämä johtuu siitä, että he suorittavat aiotut toiminnot hyvin ja hiljaa.
Vastaus
Kaikki lauseet vaikuttavat minusta hyviltä. Mutta jos haluat päästä eroon ”tästä” toisen lauseen alussa, voit kirjoittaa ensimmäisen lauseen hieman.
Esimerkiksi sen sijaan, että
Aseta yksi merkintäpoiju ankkurin GPS-sijaintiin ja toinen merkkipaikan GPS-sijaintiin. runko. Tämä tekee navigoinnista paljon helpompaa.
kirjoita
Yhden merkkipoijan käyttöönotto paikassa ankkurin GPS-sijainti ja toinen kehyksen GPS-sijainnissa helpottaa navigointia.
Sen sijaan, että
Lokitiedostot jäsennetään kalibrointiasetuksia ja muita metatietoja varten. Tämä prosessi voi viedä muutaman minuutin erittäin suurille tiedostoille.
kirjoita
Lokitiedostojen jäsentäminen kalibrointiasetuksia ja muita metatietoja varten voi viedä muutaman minuutin erittäin suurille tiedostoille.
Mielestäni kolmas esimerkki on luultavasti paras vasemmalle, kun mainitsit sen.
Kommentit
- Kuten luulen ymmärtävän, vaihtoehtosi muuttavat alkuperäisten lauseparien merkitystä. Ensimmäinen muutos menettää alkuperäisen päätoiminnon: Käyttöönoton ohjeet. Toinen muutos menettää alkuperäisen päätoiminnon: Ilmoitus jäsentämisestä.
- Ensimmäisessä voit käyttää passiivista ääntä: Prosessi helpottaa navigointia. Ei kuitenkaan suurin lause. Entä toinen, entä ” Erittäin suuret tiedostot voivat saada prosessin viemään muutaman minuutin ”?