Prosím, kliknite sem, aby ste pomohli. David McMurrey zaplaťte za webhosting:
Darujte akúkoľvek malú sumu, ktorú môžete!
Online technické písanie zostane zadarmo.
Publikum technického dokumentu—alebo akéhokoľvek písania, o ktorom hovoríme—je zamýšľaný alebo potenciálny čitateľ alebo čitatelia. Pre väčšinu technických autorov je to najdôležitejšie zohľadnenie pri plánovaní, písaní a revízii dokumentu. Musíte prispôsobiť svoje písanie potrebám, záujmom a pozadiu čitateľov, ktorí budú čítať vaše písanie.
Princíp sa zdá absurdne jednoduchý a zrejmý. Je to veľmi podobné ako povedať niekomu, "Hovorte tak, aby vás človek pred vami chápal." Je to ako povedať, "Nehovorte o raketovej vede svojmu šesťročnému dieťaťu." Potrebujeme na to kurz? Nezdá sa to. Ale v skutočnosti, nedostatok analýzy a prispôsobenia publika je jednou z hlavných príčin väčšiny problémov, ktoré nájdete v profesionálnych, technických dokumentoch—najmä v pokynoch, kde sa to prejavuje najvýraznejšie.
Poznámky:
- Akonáhle prečítate časť o publikách, skúste použiť plánovač publika. Vyplníte prázdne miesta odpoveďami na podrobné otázky o vašom publiku a potom si to e-mailom pošlete sami sebe a, voliteľne, aj svojmu inštruktorovi.
- Tento kapitola obsahuje aj sekciu o situácia. Skúste použiť plánovač situácií vyvinúť predstavu o situácii, v ktorej sa vaša publikum nachádza.
Jednou z prvých vecí, ktoré treba urobiť pri analýze publika, je identifikovať jeho typ (alebo typy—, zriedka je to len jeden typ). Bežné rozdelenie publík do kategórií je nasledovné:
- Experti: Toto sú ľudia, ktorí poznajú teóriu a produkt do najmenších detailov. Navrhli ho, testovali ho, vedia o ňom všetko. Často majú pokročilé tituly a pôsobia v akademických prostrediach alebo v oblastiach výskumu a vývoja v štátnej správe a technologických sférach. Nešpecializovaný čitateľ najmenej pravdepodobne porozumie tomu, čo títo ľudia hovoria, ale tiež má najmenej dôvod pokúšať sa porozumieť. Častejšie je výzvou komunikácie, ktorú odborník čelí, komunikovať s technikom a výkonným riaditeľom.
- Technici: Toto sú ľudia, ktorí stavajú, prevádzkujú, udržiavajú a opravujú veci, o ktorých odborníci navrhujú a teoretizujú. Ich znalosti sú tiež veľmi technické, ale praktickejšieho charakteru.
- Vedúci pracovníci: Toto sú ľudia, ktorí robia obchodné, ekonomické, administratívne, právne, vládne a politické rozhodnutia o veciach, s ktorými pracujú odborníci a technici. Ak ide o nový produkt, rozhodujú, či ho vyrobiť a uviesť na trh. Ak ide o novú technológiu energie, rozhodujú, či by ju mesto malo zaviesť. Vedenie má pravdepodobne rovnako málo technických znalostí o téme ako nešpecialisti.
- Nespecialisti: Títo čitatelia majú najmenej technických znalostí zo všetkých. Ich záujem môže byť rovnako praktický ako u technikov, ale iným spôsobom. Chcú porozumieť novej energetickej technológii dostatočne na to, aby vedeli, či za ňu hlasovať alebo proti nej v nadchádzajúcich voľbách o dlhopisoch. Alebo môžu mať len zvedavosť o konkrétnej technickej otázke a chcieť sa o nej dozvedieť, ale bez konkrétneho, praktického dôvodu.
Analýza publika
Je dôležité určiť, do ktorej zo štyroch práve diskutovaných kategórií potenciálni čitatelia vášho dokumentu patria, ale to nie je koniec. Publikum, bez ohľadu na kategóriu, musí byť tiež analyzované z hľadiska charakteristík, ako sú nasledujúce:
- Pozadie—znalosti, skúsenosti, školenie: Jednou z vašich najdôležitejších úvah je, aké množstvo znalostí, skúseností alebo školení môžete očakávať od vašich čitateľov. Ak očakávate, že niektorí vaši čitatelia budú mať nedostatok určitých znalostí, automaticky to poskytnete vo vašom dokumente? Zvážte príklad: predstavte si, že píšete príručku na používanie softvérového produktu, ktorý funguje pod Microsoft Windows. Koľko toho môžete očakávať, že vaši čitatelia budú vedieť o Windows? Ak niektorí pravdepodobne vedia málo o Windows, mali by ste tieto informácie poskytnúť? Ak poviete nie, vystavujete sa riziku, že zákazníci budú frustrovaní vašim produktom. Ak poviete áno k pridaniu pozadia o Windows, zvýšite nároky na vašu prácu a pridáte k počtu strán dokumentu (a tým aj k nákladom). Očividne, na túto otázku neexistuje jednoduchá odpoveď, časť odpovede môže zahŕňať, aká malá časť publika potrebuje tieto základné informácie.
- Potrebnosti a záujmy: Aby ste naplánovali svoj dokument, potrebujete vedieť, čo vaša cieľová skupina očakáva od tohto dokumentu. Predstavte si, ako čitatelia budú chcieť použiť váš dokument; čo od neho budú požadovať. Napríklad, predstavte si, že píšete príručku o tom, ako používať nový smartfón—čo budú vaši čitatelia očakávať, že v nej nájdu? Predstavte si, že ste na zmluve, aby ste napísali pozadie správy o globálnom otepľovaní pre národnú asociáciu nehnuteľností—čo chcú čítať; a rovnako dôležité, čo chcú. nie o čom chceš čítať?
- Rôzne kultúry: Ak píšete pre medzinárodné publikum, majte na pamäti, že formáty na vyjadrenie času a dátumov, peňažných a číselných súm sa po celom svete líšia. Takisto si uvedomte, že humor a obrazný jazyk (ako napríklad „udriť homerun“) pravdepodobne nebudú pochopené mimo našej kultúry. Texas A&M University poskytuje Kapitola 6, "Písanie pre medzinárodných čitateľov," z Hlásenie technických informácií, Elizabeth Tebeaux a kol. Pre štandardy pozri Zoznam štýlových príručiek z Wikipédie. (Ďakujeme anonymnému návštevníkovi, ktorý prispel týmito dôležitými nápadmi.)
- Iné demografické charakteristiky: A samozrejme, existuje mnoho ďalších charakteristík vašich čitateľov, ktoré môže majú vplyv na to, ako by ste mali navrhnúť a napísať váš dokument—napríklad vekové skupiny, typ bydliska, oblasť bydliska, pohlavie, politické preferencie a tak ďalej.
Analýza publika môže byť zložitá aspoň dvoma ďalšími faktormi: zmiešané typy publika pre jeden dokument, široká variabilita v rámci publika a neznáme publikum.
- Viacero publík. Je pravdepodobné, že váš dokument je určený pre viac ako jednu cieľovú skupinu. Napríklad, môže byť čítaný technickými odborníkmi (expertmi a technikmi) a administratívnymi pracovníkmi (vedúcimi). Čo robiť? Môžete buď napísať všetky sekcie tak, aby všetky cieľové skupiny vášho dokumentu im rozumeli (veľa šťastia!). Alebo môžete napísať každú sekciu striktne pre publikum, ktoré by malo záujem o danú tému, a potom použiť nadpisy a úvody sekcií, aby ste upozornili svoje publikum, kam ísť a čomu sa vyhnúť vo vašom dokumente.
- Veľká variabilita publika. Môžete si uvedomiť, že aj keď máte publikum, ktoré spadá iba do jednej kategórie, jeho pozadie sa veľmi líši. Toto je ťažká otázka—ak píšete na najnižšej spoločnej menovateľ čitateľa, pravdepodobne skončíte s ťažkopádnou, nudnou knihou, ktorá odradí väčšinu čitateľov. Ale ak nepíšete na tejto najnižšej úrovni, prídete o tú časť svojich čitateľov. Čo robiť? Väčšina autorov sa orientuje na väčšinu čitateľov a obetuje tú menšinu, ktorá potrebuje viac pomoci. Iní vkladajú doplnkové informácie do príloh alebo vkladajú krížové odkazy na knihy pre začiatočníkov.
Príklad analýzy publika
Ak absolvujete kurz technického písania, môžete byť požiadaní, aby ste priložili popis publika k vašim technickým dokumentom. Tu je príklad:
| Poznámka pre inštruktora: Tieto pokyny sú určené pre jednotlivcov, ktorí chcú zjednodušiť svoje výpočty pomocou programu Microsoft Excel a makier na efektívne spracovanie svojich údajov. Rozumejú tomu, ako zadávať údaje do programu Microsoft Excel, a majú základné znalosti o sade Microsoft Office. Sú pohodlní pri používaní softvéru Windows a majú základné aritmetické schopnosti na overenie svojich výpočtov a kontrolu logických chýb pri počítaní. |
Prispôsobenie publiku
Dobre! Takže si analyzoval svoje publikum, až ho poznáš lepšie, než poznáš sám seba. Aký z toho máš prospech? Ako túto informáciu využiješ? Ako sa vyhneš tomu, aby si napísal niečo, čo bude pre tvojich čitateľov stále nepochopiteľné alebo zbytočné?
Biznis písania na vaše publikum môže mať veľa spoločného s vrodeným talentom, intuícou a dokonca aj mystériom. Ale existujú určité nástroje, ktoré môžete použiť, aby ste mali lepšiu šancu spojiť sa so svojimi čitateľmi. Nasledujúce "nástroje" majú väčšinou do činenia s tým, ako urobiť technické informácie zrozumiteľnejšími pre nešpecializované publikum:
- Pridajte informácie, ktoré čitatelia potrebujú na pochopenie vášho dokumentu. Skontrolujte, či nie sú chýbajúce určité kľúčové informácie—napríklad kritická séria krokov zrejúceho súboru inštrukcií; dôležité pozadie, ktoré pomáha začiatočníkom pochopiť hlavnú diskusiu; definícia kľúčových termínov. (Pozri kapitolu na nápady na obsah pre detaily.)
- Vynechajte informácie, ktoré vaši čitatelia nepotrebujú. Zbytočné informácie môžu tiež zmiasť a frustrovať čitateľov—napokon, je tam, aby sa cítili povinní to čítať. Napríklad, pravdepodobne môžete odstrániť teoretickú diskusiu z základných pokynov.
- Zmeňte úroveň informácií, ktoré aktuálne máte. Môžete mať správne informácie, ale môžu byť "prezentované" na príliš vysokej alebo príliš nízkej technickej úrovni. Môžu byť prezentované nesprávnemu typu publika—napríklad odbornému publiku, namiesto technického publika. K tomu dochádza najčastejšie, keď sa poznámky k návrhu produktu vydávajú za pokyny.
- Pridajte príklady, aby ste čitateľom pomohli pochopiť. Príklady sú jedným z najsilnejších spôsobov, ako sa spojiť s publikom, najmä v pokynoch. Aj v neinstruktívnom texte, napríklad, keď sa snažíte vysvetliť technický koncept, sú príklady veľkou pomocou—najmä analógiami.
- Zmeňte úroveň svojich príkladov. Môžete používať príklady, ale technický obsah alebo úroveň nemusia byť vhodné pre vašich čitateľov. Domáce príklady nemusia byť užitočné pre odborníkov; veľmi technické príklady môžu úplne minúť vašich nešpecializovaných čitateľov.
- Zmeňte organizáciu svojich informácií. Niekedy môžete mať všetky správne informácie, ale usporiadať ich nesprávne. Napríklad môže byť príliš veľa základných informácií na začiatku (alebo príliš málo), takže niektorí čitatelia sa môžu stratiť. Niekedy je potrebné základné informácie skonsolidovať do hlavných informácií—napríklad v pokynoch je niekedy lepšie do bodov, kde ich okamžite potrebujete, pridávať dávky základných informácií. (Pozrite sa na kapitoly o štruktúra a organizácia informácie v dokumente.)
- Posilnite prechody. Môže byť pre čitateľov, najmä nespecialistov, ťažké vidieť spojenia medzi hlavnými sekciami vášho dokumentu, medzi jednotlivými odsekmi a niekedy dokonca aj medzi jednotlivými vetami. Tieto spojenia môžete urobiť oveľa jasnejšími pridaním prechodové slová a opakovaním kľúčové slová presnejšie. Slová ako "preto," "napríklad," "avšak" sú prechodové slová—naznačujú logiku spájajúcu predchádzajúcu myšlienku s nasledujúcou myšlienkou. Prechody môžete tiež posilniť starostlivým opakovaním tých istých kľúčových slov. V technickej próze je to nie dobrý nápad je variabilne voliť slová—používať tie isté slová, aby sa ľudia ešte viac nezmiatli, ako už možno sú. (Pozrite si kapitolu o prechody.)
- Napíšte silnejšie úvody—pre celý dokument a pre hlavné sekcie. Ľudia sa zdajú čítať s väčšou dôverou a pochopením, keď majú "veľký obraz"—prehľad o tom, čo prichádza, a ako to súvisí s tým, čo práve prečítali. Preto sa uistite, že máte silný úvod k celému dokumentu—ktorý jasne uvádza tému, účel, cieľovú skupinu a obsah tohto dokumentu. A pre každú hlavnú sekciu vo vašom dokumente použite mini-úvody, ktoré naznačujú aspoň tému sekcie a poskytujú prehľad podtém, ktoré budú v tejto sekcii pokryté. (Pozri kapitolu o úvody ako pre celé správy, tak aj pre sekcie v rámci správ.)
- Vytvorte témy viet pre odseky a skupiny odsekov. Môže to čitateľom nesmierne pomôcť, ak im poskytnete predstavu o téme a účele sekcie (skupiny odsekov) a najmä ak im poskytnete prehľad o podtémach, ktoré budú pokryté. Mapa pomáha, keď ste v inej situácii! (Pozrite sa na kapitolu o používanie prehľadov a tematických viet.)
- Zmeňte štýl a dĺžku viet. Ako píšete—na úrovni jednotlivých viet—môže tiež významne ovplyvniť. Napríklad pri inštrukciách je používateľská imperatívna forma a "vy"formulácia podstatne zrozumiteľnejšia ako pasívna forma alebo formulácia v tretej osobe. Z nejakého dôvodu môže personalizácia vášho štýlu písania a jeho uvoľnenie a neformálnosť spraviť text prístupnejším a ľahšie pochopiteľným. Pasívne, bezosobné písanie je ťažšie na čítanie—vložiť do svojho písania ľudí a činnosť. Rovnako sa zamerajte na aktívne slovesá namiesto buď verbálne vyjadrenie. To všetko robí vaše písanie priamočiarejším a bezprostrednejším—čitatelia to nemusia hľadať. (Pozrite si kapitolu o bežné problémy so vetným štýlom pre podrobnosti.)
A samozrejme, dĺžka viet je tiež dôležitá. Priemerný počet slov na vetu by mal byť niekde medzi 15 a 25; vety dlhšie ako 30 slov by sa mali brať s rezervou. - Pracujte na jasnosti a úspornosti vet. Toto úzko súvisí s predchádzajúcou "kontrolou", ale zaslúži si vlastné miesto. Často môže byť štýl písania taký zložitý, že je ťažké alebo frustrujúce ho čítať. Keď revidujete svoje hrubé náčrty, dajte ich na diétu—prechádzajte náčrt riadok po riadku a snažte sa znížiť celkový počet slov, strán alebo riadkov o 20 percent. Vyskúšajte to ako experiment a uvidíte, ako to dopadne. Zistíte, že tam je veľa komplikovaných, zbytočných detailov a nafúknutých fráz, ktoré môžete odstrániť. (Pozrite si kapitolu o bežné problémy so štylom viet a jasnosťou pre podrobnosti.)
- Použite viac alebo iné grafiky. Pre nespecializované publikum možno chcete použiť viac grafiky—a jednoduchšie. Grafika pre špecialistov je podrobnejšia, technickejšia. V technických dokumentoch pre nespecialistov je tiež tendenciou mať viac "dekoratívnej"grafiky—takej, ktorá je atraktívna, ale nemá žiadny prísny informačný alebo presadzovací účel. (Pozri kapitolu o grafika pre podrobnosti.)
- Rozdeľte text na významné, použiteľné časti alebo ho zlaďte do súvislých blokov. Pre neodborných čitateľov môžete potrebovať kratšie odseky. Možno je obvyklý maximálny odsek dlhý 6 až 8 riadkov. Všimnite si, ako sú odseky v technických dokumentoch pre odborníkov oveľa dlhšie.
- Pridajte krížové odkazy na dôležité informácie. V technických informáciách môžete pomôcť nespecializovaným čitateľom tak, že ich nasmerujete na zdroje na pozadí. Ak nie ste schopný plne vysvetliť tému na mieste, ukážte na časť alebo kapitolu, kde sa to nachádza. (Pozrite sa na kapitolu o krížové odkazy pre podrobnosti.)
- Použite nadpisy a zoznamy. Čitatelia môžu byť zastrašení veľkými, hutnými odsekmami textu, ktoré nie sú rozdelené ničím iným ako občasnou prázdnou líniou. Hľadajte vo svojich hrubých náčrtoch spôsoby, ako zapracovať nadpisy—hľadajte zmeny v téme alebo podtéme. Prehľadávajte svoj text na zoznamy vecí—tieto môžu byť prevedené na vertikálne zoznamy. Hľadajte párové zoznamy, ako sú pojmy a ich definície—tieto môžu byť prevedené na dvojstĺpcové zoznamy. Samozrejme, buďte opatrní, aby ste túto špeciálnu formátovanie neprehnali—nepreháňajte to. (Pozrite sa na kapitoly o nadpisy a zoznamy pre podrobnosti.)
- Použite špeciálnu typografiu a pracujte s okrajmi, dĺžkou riadku, výškou riadku, velikosťou písma a štýlom písma. Pre nespecializovaných čitateľov môžete robiť veci ako skrátiť riadky (zúžení okrajov), používať väčšie veľkosti písma a iné podobné taktiky. Určité typy štýlov písma sa považujú za priateľskejšie a čitateľnejšie ako iné. (Snažte sa nájsť niekoho zapojeného do publikovania, aby ste získali nejaké postrehy o písmach.)
Tieto sú druhy "kontrol" ktoré profesionálni technickí spisovatelia používajú na jemné doladenie svojej práce a aby bola čo najlepšie zrozumiteľná. A naopak, je to nahromadenie mnohých problémov v týchto oblastiach—aj zdánlivo triviálnych—ktoré sa sčítajú a spôsobujú, že dokument je ťažko čitateľný a pochopiteľný. Neprofesionáli často kladú otázku, prečo profesionálni spisovatelia a redaktori trvajú na zaoberaní sa takými naoko puntičkárskymi, triviálnymi, malichernými detailami v písaní—ale všetky sa sčítajú! Pripomína mi to starodávnu čínsku metódu popravy nazývanú "smrť miliónom rezov." Avšak v tomto prípade by to bolo "zmätenie tisíckou drobných problémov."
Analýza situácie a vynález
Nestačí len vybrať tému a definovať publikum pre technickú písanie. Musíte poznať (alebo vymyslieť) situácia v ktorých táto publikum funguje — aké sú jej ciele: vyriešiť problém, umožniť zlepšenie, podporiť rozhodovanie? Situácie pre písanie technickej dokumentácie sú pravdepodobne také nekonečné ako ľudské sociálne vzťahy. Situácia technickej dokumentácie zahŕňa publikum, ktoré potrebuje alebo žiada určitý typ technickej dokumentácie pre svoje špecifické potreby a použitie. Pre podrobnosti, pozri Analýza situácie a vynález
Súvisiace informácie
Kvíz o čítaní. Použite tento kvíz na otestovanie vašich znalostí o tejto kapitole.
Dostupné školenie. Získajte nejakú prax v písaní s McMurrey ako váš inštruktor.
Používanie prieskumov na odhalenie poznatkov o publiku. BrightTalk
Publikum. Univerzita Severnej Karolíny v Chapel Hill
Ocenil by som vaše myšlienky, reakcie, kritiku týkajúcu sa tejto kapitoly: tvoja odpoveď—David McMurrey
