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 zdarma.
Recenzovanie kolegov (známe aj ako vzájomné posudzovanie) znamená, že sa ľudia stretávajú, aby čítali, komentovali a odporúčali vylepšenia navzájom na svojich prácach. Vzájomné posudzovanie je dobrý spôsob, ako sa stať lepším spisovateľom: poskytuje skúsenosti s kritickým pohľadom na písanie. Vzájomné posudzovanie je tiež skvelý spôsob, ako zlepšiť písacie projekty.
Tímové písanie, ako naznačuje jeho názov, znamená, že sa ľudia stretávajú, aby spoločne plánovali, písali a revízovali písanie ako skupina alebo tím. Ďalší názov pre túto prax je kolaboratívne písanie—kolaboratívne písanie, ktoré sa dejú na verejnosti, nie v skryte (kde je známe ako plagiátorstvo).
Buďte si vedomí, že v posledných rokoch sa objavili softvérové aplikácie na tímové projekty, pričom Atlassian Confluence je jednou z populárnych. Poskytuje priestory pre členov tímu, aby mali kancelárie, priestory na konanie tímových stretnutí, mechanizmy na sledovanie dokumentov a ďalšie. Online kurz je k dispozícii na McMurrey Associates: Kurzy technickej komunikácie Tím technického písania Confluence Projekty
Stratégie pre posudzovanie rovesníkov
Keď recenzujete prácu iného autora, hodnotíte ju, kritizujete ju, navrhujete vylepšenia a potom to všetko komunikujete autorovi. Ako prvýkrát recenzent sa môžete cítiť trochu nervózne pri kritike práce niekoho iného. Napríklad, ako povedať niekomu, že jeho esej je nudná? Prečítajte si nasledujúcu diskusiu; nájdete tu rady a usmernenia na vykonávanie recenzií a komunikáciu komentárov k recenziám.
Úvodné stretnutie. Na začiatku hodnotenia od kolegov by mal autor poskytnúť recenzentom poznámky o písomnej úlohe a o cieľoch a obavách týkajúcich sa písania (téma, publikum, účel, situácia, typ) a upozorniť ich na akékoľvek problémy alebo obavy. Ako autor chcete upozorniť recenzentov na tieto problémy; jasne vyjadrite, aké veci ste sa snažili dosiahnuť. Podobne by mali recenzenti požiadať autorov, ktorých dielo hodnotia, aby poskytli informácie o svojich cieľoch a obavách. Otázky na hodnotenie by mali byť konkrétne ako nasledujúce:
Má moja vysvetlenie virtuálnej mašiny zmysel? Dávalo by zmysel aj našim najmenej technicky zdatným zákazníkom?
Vo všeobecnosti, je môj štýl písania príliš technický? (Možno som príliš napodobňoval špecifikácie inžinierov.)
Sú názvy kapitol a nadpisy dostatočne výstižné pre nasledujúci obsah? (Mal som problémy s formulovaním niektorých z nich.)
Sú snímky obrazovky dostatočne jasné? (Možno som sa pokúšal získať príliš veľa detailov v niektorých z nich.)
Stratégie pre recenzovanie prác. Keď hodnotíte písanie iných, pamätajte na to, že by ste mali zvážiť všetky aspekty tohto písania, nie len —, v skutočnosti najmenej —, gramatiku, pravopis a interpunkciu. Ak ste noví v hodnotení, môžete zabudnúť skontrolovať návrh na veci ako sú nasledovné:
- Uistite sa, že vaša recenzia je komplexná. Zvážte všetky aspekty návrhu, ktorý posudzujete, nielen gramatiku, interpunkciu a pravopis.
- Prečítajte si návrh niekoľkokrát a hľadajte kompletný rozsah potenciálnych problémových oblastí:
- Úroveň záujmu, prispôsobenie sa publiku
- Presvedčivosť, účel
- Obsah, organizácia
- Jasnosť diskusie
- Koherencia, používaj prechody
- Názov, úvod a záver.
- Štýl vety a jasnosť
- Spracovanie grafiky
- Buďte opatrní pri komentovaní alebo kritizovaní, ktoré vychádzajú z vášho vlastného osobného štýlu. Založte svoje kritiky a návrhy na zlepšenia na všeobecne prijatých usmerneniach, konceptoch a pravidlách. Ak urobíte komentár, ktorý je naozaj len vašou preferenciou, vysvetlite ho.
- Vysvetlite problémy, ktoré nájdete, podrobne. Nepovedzte len to, že dokument "sa zdá byť neorganizovaný." Vysvetlite, čo je v dokumente neorganizované. Použite konkrétne detaily z návrhu, aby ste podporili svoj názor.
- Kedykoľvek kritizujete niečo v autorskom návrhu, skúste navrhnúť nejaký spôsob, ako problém opraviť. Nie je dostatočné povedať autorovi, že jeho dokument sa zdá byť neorganizovaný, napríklad. Vysvetlite, ako by sa tento problém mohol vyriešiť.
- Zakladajte svoje komentáre a kritiky na akceptovaných usmerneniach, konceptoch, princípoch a pravidlách. Nie je dostatočné povedať autorovi, že by sa mali vymeniť dva odstavce, napríklad. Uveďte dôvod, prečo: všeobecnejšie, úvodné informácie by mali prísť na začiatok, napríklad.
- Vyhnite sa prepísaniu návrhu, ktorý recenzujete. Pri snahe navrhnúť vylepšenia a opravy nezabudnite nepreháňať a nenapíšte návrh sami. Týmto odoberáte autorovi vlastníctvo dokumentu a odoberáte mu príležitosť učiť sa a zlepšovať sa ako autor.
- Nájdite pozitívne, povzbudzujúce veci, ktoré môžete povedať o návrhu, ktorý recenzujete. Komplimenty, aj tie malé, sú zvyčajne veľmi ocenené. Prečítajte si návrh aspoň raz a hľadajte veci, ktoré boli urobené dobre, a potom dajte autorovi vedieť o nich.
Zhrnutie recenzie kolegov. Keď dokončíte hodnotenie od kolegu, je dobré napísať súhrn svojich myšlienok, pozorovaní, dojmov, kritiky alebo pocitov o hrubom náčrte. Pozrite si poznámku recenzenta nižšie, ktorá sumarizuje pozorovania k hrubému náčrtu. Všimnite si v poznámke niektoré z nasledujúcich detailov:
- Komentáre sú kategorizované podľa typu problému alebo chyby—gramatické a používané komentáre v jednej skupine; komentáre na vyššej úrovni, ako sú veci týkajúce sa obsahu, organizácie a úrovne záujmu v druhej skupine.
- Relatívna dôležitosť skupín komentárov je indikovaná. Recenzent označuje, ktoré návrhy by bolo "pekné" zahrnúť a ktoré sú kľúčové pre úspech písania projektu.
- Väčšina komentárov obsahuje niekoľko krátkych vyhlásení smerníc, pravidiel, príkladov alebo zdravého rozumu. Recenzent jednoducho nepovie „Toto je zle; oprav to.“ Taktiež vysvetlí dôvod pre komentár.
- Otázky sú adresované autorovi. Recenzent overuje, či autor skutočne zamýšľal uviesť alebo naznačiť určité veci.
- Recenzent zahrňuje pozitívne komentáre k hrubému návrhu a nachádza neantagonistické, súcitné spôsoby, ako vyjadriť kritiku.
Úryvok z poznámky sumarizujúcej výsledky hodnotenia kolegami. Strávte chvíľu zhrnutím svojich komentárov z recenzie v krátkej poznámke autorovi. Buďte čo najdiplomatickejší a najempatickejší!
Strategie pre tímové písanie
Ako sme už spomínali v tejto kapitole, písanie v tíme je jedným z bežných spôsobov, ako sa ľudia vo sfére biznisu, vlády, vedy a technológie zaoberajú veľkými písacími projektmi.
Infografika generovaná NotebookLM tejto kapitoly
Zostavenie tímu. Keď začnete vyberať členov tímu pre písací projekt v kurze technického písania, vyberte ľudí s rôznymi záznamami a záujmami. Rovnako ako rozmanitý, komplexný background jednotlivého autora je výhodou, skupina rozmanitých jednotlivcov vytvára vyvážený písací tím.
Ak ste tímovým lídrom, môžete sa dokonca spýtať potenciálnych členov tímu na ich pozadie, záujmy, študijné odbory, talenty a nadania. Nasledujúce písacie tímy spájajú jednotlivcov s rôznorodým pozadím a záujmami:
| Písací tím: Červené písacie kapucne | |
| Projekt: | Správa o aktuálnom technológie zakrývania |
| Členovia tímu | Pozadia, zručnosti, záujmy |
| Shawn S. | Hlavný odbor elektrotechniky, v súčasnosti vykonávam základné kancelárske úlohy v právnickej firme |
| Tracey K. | Študentka angličtiny na vyššom ročníku, dúfajúca, že tento kurz pomôže s možnosťami zamestnania. |
| Sanjiv Gupta | Študent informatiky, aktuálne pracujem na počítačovej grafike v kancelárii pre vývoj softvéru. |
| Jeon Chang Yeon | Čoskoro študent elektrotechniky, stále zlepšujúci anglické jazykové schopnosti |
| Alice B. | Nezvolený odbor s netechnickým zameraním, pravdepodobne v nesprávnom kurze, bez uvedených zručností. |
Plánovanie projektu. Akonáhle zostavíte svoj tím na písanie, väčšina práce je rovnaká, ako keby ste písali sami—okrem toho, že každá fáza je tímová práca. Konkrétne sa stretnite so svojím tímom, aby ste sa dohodli alebo naplánovali nasledujúce:
Fázy plánovania
|
Zaznamenajte profily a rozhodnutia vášho tímu jednoducho dokument tímového plánu. Môže obsahovať kľúčové dátumy v harmonograme tímu, predbežný náčrt dokumentu, ktorý má tím vypracovať, dohodu o formátovaní, individuálne priradenia autorov, preferencie vo výbere slov a podobne. Nižšie je uvedené, že existuje dokument o stanovách. Ten môže byť tiež zahrnutý do tímového plánu.
Veľká časť práce v projekte tímového písania musí byť vykonaná jednotlivými členmi tímu samostatne. Avšak, ak sa váš tím rozhodne prerozdeliť prácu na písacom projekte, snažte sa dodržiavať aspoň tieto minimálne pokyny:
- Nech je každý člen tímu zodpovedný za písanie jednej hlavnej časti dokumentu.
- Nech má každý člen tímu na starosti vyhľadanie, prečítanie a zaznačenie rokov náhodných informačných zdrojov.
Niektoré úlohy pre projekt, ktoré môžu byť vykonané ako tím, by ste mohli chcieť najskôr urobiť samostatne. Napríklad brainstormovanie, zúženie a najmä vytváranie osnovy by malo najprv vykonať každý člen tímu samostatne; potom sa stretnite a porovnajte si poznámky. Majte na pamäti, ako skupinová dynamika môže neúmyselne potlačiť určité nápady a ako menej asertívni členovia tímu by mohli byť nepríjemní pri prispievaní svojich cenných nápadov v skupinovom prostredí.
Po rozdelení práce na projekte vytvorte formálny diagram a rozdeľte ho všetkým členom.
Graf zobrazujúci zodpovednosti členov písania tímu pre projekt
Naplánovanie projektu a vyváženie pracovnej záťaže. Na začiatku vášho tímového písania si nastavte plán kľúčových dátumov. Tento plán vám a vašim kolegom umožní dosiahnuť stabilný, organizovaný pokrok a dokončiť projekt včas. Ako je uvedené v príklade plánu nižšie, zahrňte nielen termíny dokončenia kľúčových fáz projektu, ale aj dátumy stretnutí a tému a účel týchto stretnutí. Všimnite si tieto detaily ohľadom plánu:
- Niekoľko stretnutí je naplánovaných, na ktorých členovia diskutujú o informáciách, ktoré nachádzajú alebo nenachádzajú. (Jeden člen tímu môže mať informácie, ktoré iný člen hľadá všade.)
- Viaceré stretnutia sú naplánované na preskúmanie podrobností projektu, konkrétne tému, publikum, účel, situáciu a osnovu. Keď sa dozviete viac o téme a stanete sa komfortnejšími v projekte, váš tím môže chcieť zmeniť niektoré z týchto podrobností alebo ich spraviti presnejšími.
- Viacero hrubých návrhov je naplánovaných. Členovia tímu si navzájom recenzujú návrhy jednotlivých sekcií aspoň dvakrát, druhýkrát, aby zistili, či odporúčané zmeny zafungovali. Akonáhle je kompletný návrh poskladaný, je taktiež prehodnotený dvakrát.
Harmonogram pre tímový písací projekt
Očakávanie problémov a vytváranie pravidiel tímu. Premýšľajte o tom, ako vyriešiť typické problémy, ktoré môžu vzniknúť v tímovom projekte, a zdokumentujte dohody vášho tímu o týchto záležitostiach v a stanovy dokument:
- Nerovnomerné rozdelenie pracovnej záťaže. Keď pracujete ako tím, vždy existuje šanca, že jeden z členov tímu, z akéhokoľvek dôvodu, môže mať viac alebo menej než spravodlivý podiel na pracovnej záťaži. Preto je dôležité nájsť spôsob, ako sledovať, čo každý člen tímu robí. Dobrým spôsobom, ako to urobiť, je nechať jednotlivých členov tímu viesť denník alebo záznam o tom, aký druh práce vykonávajú a koľko času tomu venujú.
Ako počas, tak na konci projektu, ak sa vyskytnú nejaké problémy, by mal denník jasne uvádzať tento fakt a umožniť spravodlivejšie vyváženie pracovného zaťaženia. Na konci projektu si členovia tímu môžu spočítať hodiny strávené na projekte; ak niekto strávil o niečo viac času, než bola jej podiel, ostatní členovia to môžu vykompenzovať tým, že jej pozvú na večeru alebo jej dajú nejakú odmenu. Podobne, keď sa blížite k záveru projektu, ak je z denníkov jasné, že pracovné povinnosti jedného člena tímu boli, bez jeho vlastnej viny, menšie ako povinnosti ostatných, môže to vykompenzovať tak, že sa postará o viac dokončovacích prác, ako je písanie, korektúra alebo kopírovanie. - Členovia tímu bez relevantných zručností. Ako môžete vidieť v príklade popisu zručností členov tímu vyššie, jeden člen nemá relevantné zručnosti, ktorými by mohol prispieť k projektu. Niekedy to len naznačuje úzkosť tej osoby alebo nedostatok záujmu zapojiť sa do skupinového projektu. Samozrejme, každý člen tímu na kurze písania by mal prispieť spravodlivým podielom písania pre projekt. Avšak existuje množstvo úloh, ktoré si nevyžadujú technické znalosti, formátovacie zručnosti alebo ostrý redakčný pohľad, napríklad: prepisovanie a distribuovanie tímového plánu, stanov, zápisníc z tímových stretnutí; pripomínanie členom tímu termínov a naplánovaných stretnutí. V skutočnosti, okrem úzkosti alebo nedostatku záujmu, by sebaistý člen tímu bez zručností mohol byť najlepším vedúcim tímu!
- Zmiznúci členovia tímu. Ak je vaša skupina taká nešťastná, že má nezodpovedného člena, ktorý jednoducho zmizne, majte plán, čo s tým robiť, a zdokumentujte to vo svojich tímových stanovách. Jedným z očividných riešení je vykázať člena tímu z tímu a informovať inštruktora, ak ide o kurz písania, alebo najbližšieho manažéra, ak ide o neakademickú organizáciu.
- Zjavne zakorenené nezhody medzi členmi tímu. Je úžasné, ako vehementne sa môžu členovia tímu rozchádzať v názoroch na aspekty projektu tímového písania. Majte plán, napísaný vo vašich tímových stanoveniach, ako tieto záležitosti vyriešiť. Mali by sa dať na hlasovanie? Mali by ste túto otázku „eskalovať“ na neutrálnu alebo vyššiu stranu?
- Radikálne nekonzistentné písacie štýly a formát. Pretože jednotlivé sekcie budú písané rôznymi autormi, ktorí majú rôzne štýly písania, vytvorte štýlovú príručku, v ktorej členovia tímu uvedú svoje dohody o tom, ako sa má s dokumentom zaobchádzať ako celkom. Tieto dohody môžu zahŕňať široké úrovne, napríklad, či mať sekciu s pozadím, až po presné detaily, ako napríklad, kedy používať kurzívu alebo tučné písmo a či je to "klik" alebo "kliknite na." Pozrite sa na úryvok z projektovej štýlovej príručky nižšie. Na diskusiu o týchto položkách, pozri štýlové listy a štýlové príručky.
Predtým, než vy a vaši členovia tímu napíšete prvé hrubé náčrty, nemôžete očakávať, že predpoviete každý možný rozdiel v štýle a formáte. Preto plánujte aktualizovať tento štýlový dokument, keď budete prehliadať hrubé náčrty jednotlivých sekcií a, najmä, keď budete prehliadať kompletný náčrt.
Úryvok z príručky štýlu pre písmenný projekt. Položky uvedené nižšie predstavujú dohody, ktoré autori tímu uzavreli, aby dodali svojmu dokumentu čo najväčšiu konzistenciu.
Kontrola návrhov a dokončovanie. Snažte sa naplánovať čo najviac hodnotení písanej práce vášho tímu. Môžete sa stretnúť, aby ste prediskutovali vzájomné hrubé verzie jednotlivých sekcií, ako aj hrubé verzie celého dokumentu. Keď sa stretnete, dodržiavajte návrhy na vzájomné redigovanie, ktoré boli prediskutované v predchádzajúcej časti tejto kapitoly. Strategie pre hodnotenie prác kolegami.
Kritická fáza pri tímovom písaní dokumentu nastáva, keď spojíte do jedného kompletného návrhu jednotlivé sekcie napísané rôznymi členmi tímu. Vtedy pravdepodobne uvidíte, ako sú každá sekcia odlišná v tóne, spracovaní a štýle. Musíte ako skupina nájsť spôsob, ako upraviť a editovať kompletný hrubý návrh tak, aby bol čitateľný a nebolo zjavné, že ho písali traja alebo štyria rôzni ľudia.
Keď skončíte s prehľadávaním a úpravami, je čas na dokončovacie práce, aby ste pripravil návrh na odovzdanie. Táto práca je rovnaká, ako by bola, keby ste dokument písali sami, iba v tomto prípade môžu byť pracovné zaťaženia rozdelené.
Súvisiace informácie
Skutočné náklady na kontrolu dokumentácie vo Worde. clickhelp.com
Ocenil by som vaše myšlienky, reakcie a kritiku týkajúcu sa tejto kapitoly: vaša odpoveď—David McMurrey.
