Poznámky:
- Táto kapitola, ako aj zvyšok tejto učebnice technického písania, sa zameriava na zručnosti technického písania. Technický obsah tu nie je zaručený ako úspešný, presný ani aktuálny.
- Kliknite sem, prosím, aby ste pomohli David McMurrey Zaplaťte za webhosting: Darujte akúkoľvek sumu, ktorú môžete! Online technické písanie zostane zadarmo.
Zameranie tejto kapitoly je jedným z najdôležitejších všetkých využití technického písania—pokyny. Ako viete, pokyny sú to krok za krokom vysvetlenia, ako niečo urobiť: ako postaviť, prevádzkovať, opraviť, alebo udržiavať veci.
Nezabudnite si pozrieť to príklady.
Píšete súbor pokynov do práce alebo na kurz technického písania? Skúste toto sprievodca plánovaním inštrukcií.
Pokyny na písanie
Jedným z najbežnejších a zároveň najdôležitejších využití technického písania sú návody—tieto krok za krokom vysvetlenia, ako robiť veci: zmontovať niečo, obsluhovať niečo, opraviť niečo alebo vykonávať rutinnú údržbu niečoho. Ale napriek tomu, že sa to zdá také jednoduché a intuitívne, návody patria medzi najhoršie napísané dokumenty, ktoré môžete nájsť. Rovnako ako ja, pravdepodobne ste mali veľa rozčuľujúcich skúseností so zle napísanými návodmi. To, čo nasleduje v tejto kapitole, nemusí byť neomylný, bezchybný návod na písanie návodov, ale ukáže vám, ktoré techniky odborníci považujú za najlepšie.
Nakoniec, dobré písanie inštrukcií vyžaduje:
- Jasné, jednoduché písanie
- Dôkladné pochopenie postupu vo všetkých jeho technických detailoch
- Vaša schopnosť postaviť sa na miesto čitateľa, osoby, ktorá sa snaží použiť vaše pokyny
- Vaša schopnosť si predstaviť postup do najmenších detailov a zachytiť túto predstavu na papieri
- Nakoniec, vaša ochota zájsť o krok ďalej a otestovať svoje pokyny na osobe, pre ktorú ste ich písali.
Infografika tejto kapitoly vytvorená pomocou NotebookLM
Niekoľko predbežných poznámok
Na začiatku projektu písania inštrukcií je dôležité určiť štruktúru alebo vlastnosti konkrétneho postupu, o ktorom budete písať.
Publikum a situácia. Na začiatku procesu definujte publikum a situáciu vašich pokynov. Pamätajte, že definovanie publika znamená určiť jeho úroveň oboznámenia s témou ako aj ďalšie podobné detaily. Pozrite si diskusiu o publikum a kroky na použitie pri definovaní cieľových skupín.
Najdôležitejšie je, že ak ste v kurze písania, budete musieť napísať popis svojho publika a priložiť ho k svojim inštrukciám. To umožní vášmu inštruktorovi posúdiť vaše inštrukcie z hľadiska ich vhodnosti pre zamýšľané publikum. A pamätajte tiež, že v kurze technického písania je vhodnejšie písať pre nespecializované publikum—omnoho väčšia výzva pre vás ako spisovateľa.
Počet úloh. Koľko úloh je v postupe, o ktorom píšete? Použime termín postup aby sa vzťahovali na celý súbor činností, ktorým sú vaše pokyny určené. A úloha je čiastočne nezávislá skupina činností v rámci postupu: napríklad, nastavenie hodín na mikrovlnnej rúre je jednou úlohou v celkovom postupe obsluhy mikrovlnnej rúry.
Jednoduchý postup, ako výmena oleja v aute, obsahuje len jednu úlohu; neexistujú žiadne čiastočne nezávislé zoskupenia činností. Zložitejší postup, ako používanie mikrovlnnej rúry, obsahuje množstvo takýchto čiastočne nezávislých úloh: nastavenie hodín; nastavenie výkonu; používanie časovača; čistenie a údržba mikrovlnnej rúry, okrem iného. (Toto pokyny na používanie fotoaparátu sú organizované podľa úloh.)
Niektoré pokyny obsahujú iba jeden úkon, ale v rámci toho jedného úkonu je veľa krokov. Napríklad si predstavte sadu pokynov na zostavenie detskej hojdačky. Z mojej vlastnej skúsenosti ich bolo viac než 130 krokov! To môže byť trochu zastrašujúce. Dobrým prístupom je zoskupiť podobné a súvisiace kroky do fáz a pri každej novej fáze začať znovu číslovať kroky. A fáza then je skupina podobných krokov v rámci postupu zameraného na jednu úlohu. V príklade so sadou hojdačiek by nastavenie rámu bolo jednou fázou; ukotvenie konštrukcie do zeme by bolo ďalšou; zostavenie boxovej hojdačky by bolo ešte ďalšou.
Používajte orientáciu na úlohy. Zamerajte sa na úlohy, ktoré chcú vaši čitatelia vykonať; použite v nadpisoch formulácie how to alebo –ing.
Najlepší prístup k diskusii krok za krokom. Ďalšia úvaha, ktorú možno spočiatku neviete určiť, je, na čo zamerať svoje pokyny. Pre väčšinu pokynov sa môžete zamerať na úlohy, alebo sa môžete zamerať na nástroje (alebo funkcie nástrojov).
V jednom prístup k úlohe (tiež známe ako orientácia na úlohy) k pokynom na používanie služby príjmu hovorov, mali by ste mať tieto sekcie:
- nahrávanie vášho pozdravu
- prehrávanie vašich správ
- ukladanie vašich správ
- preposielanie vašich správ
- mazať vaše správy, a tak ďalej
Toto sú úlohy—typické veci, ktoré by sme s týmto strojom chceli robiť. Pre ďalšiu diskusiu, pozrite si kapitolu o analýza úlohy.
Na druhej strane, v nástrojový prístup k návodu na používanie kopírky by patrili tieto nepravdepodobné oddiely:
- kopírovať tlačidlo
- tlačidlo Zrušiť
- zväčšiť/zmenšiť tlačidlo
- tlačidlo zoraďovania/zošívania
- tlačidlo na kopírovanie veľkosti, a tak ďalej
Ak by ste navrhli súbor inštrukcií podľa tohto plánu, napísali by ste kroky na používanie každého tlačidla alebo funkcie kopírky. Inštrukcie využívajúce tento prístup k nástrojom sa ťažko dajú uplatniť. Niekedy názov tlačidla nezodpovedá úplne úlohe, s ktorou je spojené; niekedy musíte použiť viac než len jedno tlačidlo, aby ste úlohu dokončili. Napriek tomu môžu byť chvíle, keď môže byť prístup nástrojov/funkcií výhodnejší.
Skupiny úloh. Zoznam úloh nemusí byť všetko, čo musíte urobiť. Môže byť toľko úloh, že ich musíte zoskupiť, aby si čitatelia ľahšie našli jednotlivé úlohy. Napríklad nasledujúce sú bežné skupiny úloh v pokynoch:
- úlohy rozbaľovania a nastavenia
- inštalovanie a prispôsobovanie úloh
- základné prevádzkové úlohy
- rutinné úlohy údržby
- úlohy odstraňovania problémov; a tak ďalej
Bežné časti v pokynoch
Nasleduje prehľad sekcií, ktoré bežne nájdete v inštrukciách. Nepredpokladajte, že každá z nich musí byť v samotných inštrukciách, ktoré napíšete, ani že musia byť v poradí uvedenom tu, ani že sú to jediné možné sekcie v sade inštrukcií.
Keď budete čítať nasledujúce o bežných častiach v pokynoch, pozrite si ukážkové pokyny.
Schématický pohľad na pokyny. Pamätajte, že toto je typický alebo bežný model pre obsah a organizáciu—mnohé ďalšie sú možné.
Úvod. Starostlivo naplánujte úvod k svojim pokynom. Uistite sa, že spĺňa niektorú z nasledujúcich požiadaviek (nie nevyhnutne v tomto poradí), ktoré sa vzťahujú na vaše konkrétne pokyny:
- Uveďte konkrétne úlohy alebo postup, ktoré sa majú vysvetliť, ako aj rozsah pokrytia (čo nebude byť pokrytý).
- Uveďte, aké vedomosti a aké predchádzajúce skúsenosti potrebuje publikum, aby porozumelo pokynom.
- Poskytnite všeobecnú predstavu o postupe a o tom, čo dosahuje.
- Uveďte podmienky, kedy by sa tieto pokyny mali (alebo by nemali) používať.
- Poskytnite prehľad obsahu pokynov.
Pozrite si časť o úvody na ďalšiu diskusiu.
Všeobecné upozornenia, varovania, oznámenia o nebezpečenstve. Pokyny často musia upozorniť čitateľov na možnosť poškodenia ich vybavenia, pokazenia postupu a zranenia sa. Tiež musia často zdôrazniť kľúčové body alebo výnimky. Pre tieto situácie používate špeciálne upozornenia—poznámky, varovania, upozornenia a oznámenia o nebezpečenstve. Všimnite si, ako sa tieto špeciálne upozornenia používajú v príkladoch inštrukcií uvedených vyššie.
Technické pozadie alebo teória. Na začiatku určitých typov pokynov (samozrejme po úvode) môžete potrebovať diskusiu o pozadí súvisiacom s postupom. Pri niektorých pokynoch je toto pozadie kritické—inak, kroky v postupe nedávajú zmysel. Napríklad ste možno mali skúsenosti s tými softvérovými appletmi, v ktorých si definujete vlastné farby posúvaním posuvníkov pre červenú, zelenú a modrú. Aby ste skutočne pochopili, čo robíte, potrebujete mať nejaké poznatky o farbe. Podobne si môžete predstaviť, že pre určité pokyny používajúce fotoaparáty môže byť tiež potrebná nejaká teória.
Vybavenie a zásoby. Všimnite si, že väčšina pokynov obsahuje zoznam vecí, ktoré potrebujete zhromaždiť skôr, než začnete postup. To zahŕňa vybavenie, nástroje, ktoré používate v postupe (ako napríklad misky na miešanie, lyžice, formy na chlieb, kladivá, vŕtačky a píly) a zásoby, veci, ktoré sa pri postupe spotrebúvajú (napríklad drevo, farba, olej, múka a klince). V návodoch sú tieto zvyčajne uvedené buď v jednoduchom zvislom zozname alebo v dvojstĺpcovom zozname. Použite dvojstĺpcový zoznam, ak potrebujete pridať nejaké špecifikácie k niektorým alebo ku všetkým položkám—napríklad obchodné názvy, veľkosti, množstvá, typy, čísla modelov a podobne.
Diskusia o krokoch. Keď sa dostanete k samotnému písaniu krokov, treba mať na pamäti niekoľko vecí: (1) štruktúru a formát týchto krokov, (2) doplnkové informácie, ktoré môžu byť potrebné, a (3) perspektívu a všeobecný štýl písania.
Štruktúra a formát. Normálne si predstavujeme súbor inštrukcií formátovaný ako zvislé číslované zoznamy. A väčšina tomu tak aj v skutočnosti je. Normálne takto formátujete svoje krok za krokom pokyny. Existujú však niektoré varianty, ako aj ďalšie úvahy:
- Kroky v pevnom poradí sú kroky, ktoré sa musia vykonať v poradí, v akom sú uvedené. Napríklad, ak meníte olej v aute, vypustenie oleja je krok, ktorý musieť prichádzajú skôr, než sa naleje nový olej. Sú to číslované zoznamy (zvyčajne zvislé číslované zoznamy).
- Kroky s premenlivým poradím sú kroky, ktoré je možné vykonať prakticky v ľubovoľnom poradí. Dobrým príkladom sú návody na riešenie problémov, ktoré vám hovoria, aby ste skontrolovali toto, skontrolovali tamto, keď sa snažíte niečo opraviť. Takéto kroky môžete vykonať prakticky v ľubovoľnom poradí. Pri tomto type je odrážkový zoznam vhodným formátom.
- Alternatívne kroky sú tie, pri ktorých sa ponúkajú dva alebo viaceré spôsoby, ako dosiahnuť tú istú vec. Alternatívne kroky sa používajú aj vtedy, keď môžu existovať rôzne podmienky. Použite odrážkové zoznamy pri tomto type, vložte medzi alternatívy OR, alebo použite úvodnú vetu, ktorá naznačuje, že budú predstavené alternatívy.
- Vnorené kroky. V niektorých prípadoch môžu byť jednotlivé kroky v rámci postupu samy o sebe pomerne zložité a je potrebné ich rozdeliť na podkroky. V takom prípade odsadzujete ďalej a očíslujete podkroky ako a, b, c a tak ďalej.
- "Stepless" pokyny. A nakoniec existujú pokyny, ktoré sa skutočne nedajú uviesť v číslovanom zvislom zozname a ktoré len málo, ak vôbec, priamo inštruktívne usmerňujú čitateľa. Niektoré situácie musia byť natoľko všeobecné alebo natoľko variabilné, že kroky nemožno uviesť.
Pozri kapitolu o zoznamy pre štýl a formát týchto možností.
Doplnková diskusia. Často nestačí jednoducho povedať čitateľom, aby toto alebo tamto urobili. Potrebujú ďalšie vysvetľujúce informácie, napríklad ako by vec mala vyzerať pred a po kroku; prečo by im malo záležať na vykonaní tohto kroku; aký mechanický princíp stojí za tým, čo robia; ešte detailnejšie mikroúrovňové vysvetlenie kroku—diskusia o konkrétnych činnostiach, ktoré tvoria tento krok.
Problém s doplnkovou diskusiou je však v tom, že môže skryť samotný krok. Chcete, aby samotný krok—konkrétne kroky, ktoré má čitateľ vykonať—vynikal. Nechcete, aby to bolo celé pochované pod hromadou slov. Existujú aspoň dve techniky, ako sa tomuto problému vyhnúť: môžete oddeliť inštrukciu od doplnku do samostatných odstavcov; alebo môžete inštrukciu zvýrazniť tučným písmom.
Tučné zvýraznenie skutočných krokov používateľa v pokynoch. Tučné písmo pomáha odlíšiť skutočnú akciu od doplnkových informácií.
Vyvarujte sa telegrafického písania—vynechávania "implicitných" členov (the, a, an). Je pravda, že roboti takto píšu, ale my nemusíme.)
Štýl písania.
Ďalším z typických problémov štýlu písania v inštrukciách je, že ľudia majú tendenciu vynechávať členy: "Press Pause button on front panel to stop display of information temporarily" alebo "Earthperson, please provide address of nearest pizza restaurant." Prečo to robíme? Chceme byť všetci potajme robotmi? Každopádne, uistite sa, že zahrniete všetky členy (a, nejaký, ten) a ďalšie podobné slová, ktoré by sme bežne používali v inštrukciách.
Grafika v inštrukciách
Pravdepodobne ešte viac než v akejkoľvek inej forme písania (možno okrem komiksov) sú grafické prvky pre návody rozhodujúce. Niekedy slová jednoducho nedokážu vysvetliť krok. Ilustrácie sú často zásadné pre to, aby si čitatelia vedeli predstaviť, čo majú urobiť.
Na kurze technického písania, môžu od vás vyžadovať, aby ste zahrnuli ilustrácie alebo iné druhy grafiky—čo by sa bežne používali v pokynoch. Problémom však môže byť, že nemáte prístup k grafike, ktorá by bola vhodná pre vaše konkrétne pokyny, a že si vo svojich umeleckých schopnostiach nie ste veľmi istí. Existujú spôsoby, ako tieto problémy prekonať! Pozrite si návrhy v grafika. V tej kapitole uvidíte nielen odporúčania na tvorbu grafiky, ale aj požiadavky na ich formát.
Formát v inštrukciách
Nadpisy. Vo svojich pokynoch dôsledne používaj nadpisy. Zvyčajne budeš chcieť nadpisy pre akúkoľvek úvodnú sekciu, ktorú môžeš mať, sekciu „Vybavenie a materiály“, všeobecný nadpis pre samotnú sekciu pokynov a podnadpisy pre jednotlivé úlohy alebo fázy v tejto sekcii. Pozri si príklady na začiatku tejto kapitoly. Pozri nadpisy pre bežné požiadavky.
Zoznamy. Rovnako inštrukcie zvyčajne veľmi často používajú zoznamy, najmä očíslované vertikálne zoznamy pre samotné vysvetlenia krok za krokom. Jednoduché vertikálne zoznamy alebo dvojstĺpcové zoznamy sú zvyčajne vhodné pre sekciu o vybavení a zásobách. Zoznamy v rámci vety sú dobré vždy, keď poskytujete prehľad toho, čo príde. Pozri zoznamy pre bežné požiadavky.
Osobitné oznámenia. In pokynoch musíte upozorniť čitateľov na možnosti, pri ktorých môžu poškodiť svoje zariadenie, premrhať zásoby, spôsobiť zlyhanie celého postupu, zraniť seba alebo iných—dokonca aj vážne alebo smrteľne. Firmy boli žalované za nedostatok týchto špeciálnych upozornení, za zle napísané špeciálne upozornenia, alebo za špeciálne upozornenia, ktoré boli na nesprávnom mieste. Pozri špeciálne oznámenia pre úplnú diskusiu o správnom používaní týchto špeciálnych oznámení, ako aj o ich formáte a umiestnení v rámci pokynov.
Číslo, skratky, a symboly. Inštrukcie tiež používajú veľa čísel, skratiek a symbolov. Pre pokyny v týchto oblastiach.
Odsadenie upozornení v inštrukciách. V prvom príklade si všimnite, ako je upozornenie odsadené na text predchádzajúceho kroku. V druhom príklade si všimnite, že závažné upozornenie je umiestnené na začiatku, ešte pred ktorýmkoľvek z krokov.
AI prompty pre inštrukcie
Kontrolné zoznamy, ktoré sa zvyčajne nečítajú, je možné po určitej úprave použiť ako zdroj promptov pre AI. Skopírujte nasledujúce, vložte ho do systému AI, napríklad Gemini od Googlu, a zistite, čo vám mohlo uniknúť.
Poznámka: Všetky odkazy na obsah, formát, štýl pokynov alebo ich súčasti nájdete v online učebnica technického písania.
Keď chcete použiť AI na vyhodnotenie písomného projektu, predstavte sa, povedzte AI, kto ste a čo chcete. Dajte AI referenčný bod pre vykonávanie hodnotení, napríklad online učebnicu. Potom napíšte, čo má AI skontrolovať vo svojom hodnotení.
Uprav úvod tak, aby zodpovedal tvojej identite.
|
Inštrukcie pre AI výzvy Ahoj, AI. Žiadam vás, aby ste zhodnotili pokyny napísané študentom druhého ročníka vysokej školy v USA. Nižšie je zhrnutie kapitol učebnice o inštrukcie a oznámenia na použitie ako podklad pre vaše hodnotenie. (Identifikačné informácie zamaskované):
|
Súvisiace informácie
Kvíz z čítania. Použite tento kvíz na otestovanie svojho porozumenia tejto kapitoly.
Kvízy: gramatika, používanie, interpunkcia.
Ako môžem vytvoriť efektívne návody?
Skrytá cena toho, že je tak intuitívne, že nepotrebuje návod
Prispievajú prevádzkové príručky k výkonnosti podniku?
Ako písať pokyny. technický pisár
Vážil by som si vaše myšlienky, reakcie, kritiku týkajúce sa tejto kapitoly: vaša odpoveď—David McMurrey.
