Kérlek, kattints ide a segítségért. David McMurrey fizessen webtárhelyért:
Adj bármilyen kis összeget, amit tudsz!
Az Online Műszaki Írás továbbra is ingyenes marad.
Kollégák általi véleményezés (a más néven társ szerkesztés) azt jelenti, hogy az emberek összegyűlnek, hogy elolvassák, megjegyzéseket fűzzenek, és javaslatokat tegyenek egymás munkájának fejlesztésére. A társas értékelés jó módja annak, hogy jobb íróvá válj: tapasztalatot nyújt az írás kritikai szemléletéhez. A társas értékelés nagyszerű módja a írási projektek fejlesztésének is.
Csapatírás, ahogy a neve is jelzi, azt jelenti, hogy az emberek együtt tervezik, írják és javítják az írásbeli projekteket csoportban vagy csapatban. Ennek a gyakorlatnak egy másik neve a kollaboratív írás—kollaboratív írás, ami nyilvánosan történik, nem pedig a háttérben (ahol plágiumként ismert).
Legyél tudatában, hogy az utóbbi években megjelentek a csapatprojektekhez készült szoftveralkalmazások, az Atlassian Confluence pedig egy népszerű példa. Ez lehetőségeket biztosít a csapattagok számára, hogy irodáik legyenek, helyeket a csapatgyűlések lebonyolítására, dokumentumok nyomon követésére és még sok másra. Online tanfolyam érhető el a McMurrey Associates-nél: Tanfolyamok a Technikai Kommunikációban. Confluence Műszaki Írás Csapat Projektek
Stratégiák az egymás értékelésére
Amikor egy másik író munkáját véleményezed, értékeled, bírálod, javaslatokat teszel a fejlesztésére, majd mindezt kommunikálod az írónak. Első alkalommal véleményezőként kicsit bizonytalan lehetsz abban, hogy kritikát fogalmazz meg valaki más munkájával kapcsolatban. Például, hogyan mondanád el valakinek, hogy az esszéje unalmas? Olvasd el a következő beszélgetést; tanácsokat és irányelveket találsz a véleményezésről és a véleményezési megjegyzések kommunikálásáról.
Kezdő találkozó. A korai értékelés során a szerzőnak jegyzeteket kell adnia az értékelő kollégáknak a írási feladatról, valamint a projekt céljairól és aggályairól (téma, közönség, cél, helyzet, típus), és figyelmeztetnie kell őket bármilyen problémára vagy aggodalomra. Szerzőként szeretnéd felhívni az értékelők figyelmét ezekre a problémákra; egyértelművé kell tenni, hogy milyen dolgokat próbáltál elérni. Hasonlóképpen, az értékelő kollégáknak meg kell kérdezniük azokat a szerzőket, akiknek a munkáját értékelik, hogy adják meg céljaikat és aggodalmaikat. Az értékelési kérdéseknek specifikusnak kell lenniük, mint például az alábbiak:
Érthető a virtuális gépről szóló magyarázatom számodra? Értelmes lenne a legkevésbé technikai beállítottságú ügyfeleink számára?
Általában véve, túl technikai a írásstílusom? (Lehet, hogy túlságosan is utánoztam a mérnökök specifikációit.)
A fejezetcímek és alcímek eléggé jelzik a következő tartalmat? (Néhányat nehezen tudtam megfogalmazni.)
Elég tiszták a képernyőfotók? (Lehet, hogy túl sok részletet próbáltam megfogni néhányban.)
Peer-review szempontok. Amikor mások írását lektorálod, mindig tartsd szem előtt, hogy minden szempontot figyelembe kell venned, nem csak—valójában, legkevésbé—a nyelvtant, helyesírást és írásjeleket. Ha új vagy a lektorálásban, elfelejtheted átnézni a vázlatot az alábbi dolgok szempontjából:
- Gondoskodj róla, hogy a véleményed átfogó legyen. Fontolja meg a tervezet minden aspektusát, nem csupán a nyelvtant, írásjelet és helyesírást.
- Olvasd el a tervezetet többször, keresve a lehetséges problémás területek teljes spektrumát:
- Érdeklődési szint, alkalmazkodás a közönséghez
- Meggyőzőerő, cél
- Tartalom, szervezettség
- A megbeszélés világossága
- Következetesség, használj átmeneteket.
- Cím, bevezetés és következtetés.
- Mondatstílus és világosság
- Grafikák kezelése
- Légy óvatos a saját stílusodon alapuló megjegyzések vagy kritikák tételével. Alapozd a kritikáidat és a fejlesztési javaslataidat általánosan elfogadott irányelvekre, fogalmakra és szabályokra. Ha mégis olyan megjegyzést teszel, ami valóban a te preferenciád, magyarázd el.
- Magyarázd el teljesen a problémákat, amiket találsz. Ne csak annyit mondj, hogy egy dokumentum "zavarosnak tűnik." Magyarázd el, mi a zavaros a dokumentumban. Használj konkrét részleteket a tervezetből, hogy alátámaszd az érvedet.
- Bármikor, amikor kritizálsz valamit a szerző vázlatában, próbálj meg javasolni valamilyen módot a probléma megoldására. Nem elég, ha csak annyit mondasz a szerzőnek, hogy a dokumentuma látszólag rendezetlen. Magyarázd el, hogyan lehetne ezt a problémát megoldani.
- Alapozd meg megjegyzéseidet és kritikáidat elfogadott irányelvek, fogalmak, elvek és szabályok alapján. Nem elég csak annyit mondani egy írónak, hogy két bekezdőt érdemes lenne felcserélni, például. Indokold meg a miértet: általánosabb, bevezető információnak kellene előbb jönnie, például.
- Kerüld el a vázlat újraírását, amit éppen átnézel. Az ajánlások és javítások javaslása során ne ess túlzásba, és ne írd át a vázlatot magad. Ezzel elveszed az író dokumentum feletti tulajdonjogát, és megfosztod az alkalomtól, hogy tanuljon és fejlődjön íróként.
- Keress pozitív, bátorító dolgokat, amiket mondhatsz az átnézett tervezetről. A dicséretek, még a kisebbek is, általában rendkívül jól esnek. Olvasd át a tervezetet legalább egyszer, keresve azokat a dolgokat, amiket jól csináltak, majd tudasd a szerzővel.
Tárgyalási összefoglaló. Miután befejezted a bírálatot, jó ötlet összefoglalni a gondolataidat, megfigyeléseidet, benyomásaidat, kritikáidat vagy érzéseidet a vázlatról. Nézd meg az alábbi bíráló megjegyzést, amely összegzi a vázlatra vonatkozó megfigyeléseket. Figyeld meg a megjegyzésben az alábbi részletek egy részét:
- A megjegyzések a problémák vagy hibák típusa szerint vannak kategorizálva—a nyelvtani és használati megjegyzések egy csoportban; a magasabb szintű megjegyzések, mint például a tartalom, a szervezés és az érdeklődési szint másik csoportban.
- A megjegyzések csoportjainak relatív fontossága jelölve van. A bíráló jelzi, hogy mely javaslatokat lenne "jó" figyelembe venni, és melyek kritikusak az írási projekt sikeréhez.
- A legtöbb megjegyzés tartalmaz néhány rövid irányelvet, szabályt, példát vagy józan észt. A véleményező nem csupán annyit mond, hogy "Ez helytelen; javítsd ki." Hanem el is magyarázza a megjegyzés alapját.
- A kérdések a szerzőhöz szólnak. A bíráló ellenőrzi, hogy a szerző valóban azt akarta-e állítani vagy sugallni, amit írt.
- A bíráló pozitív megjegyzéseket fűz a vázlathoz, és nem antagonisztikus, együttérző módokat talál a kritikák megfogalmazására.
Kivonat egy jegyzetről, amely összefoglalja a szakmai véleményezés eredményeit. Tölts egy kis időt azzal, hogy összefoglalod a szakmai véleményezésed megjegyzéseit egy rövid üzenetben az író számára. Légy minél diplomatikusabb és megértőbb!
Csapatírási stratégiák
Ahogy korábban említve lett ebben a fejezetben, a csapatírás az egyik általános módja annak, ahogyan az emberek az üzleti, kormányzati, tudományos és technológiai világokban a nagyobb írási projekteket kezelik.
A NotebookLM által készített infográfia erről a fejezetről
A csapat összeállítása. Amikor elkezded kiválasztani a csapattagokat egy írási projekthez egy technikai írás kurzusban, válassz különböző háttérrel és érdeklődési körrel rendelkező embereket. Ahogyan egy sokszínű, jól megférő háttér egyéni író számára előny, úgy egy sokszínű egyénekből álló csoport jól megférő írói csapatot alkot.
Ha te vagy a csapat vezetője, akár meg is kérdezheted a leendő csapattagokat háttérükről, érdeklődési köreikről, szakmáikról, tehetségeikről és képességeikről. Az alábbi írócsapatok különböző háttérrel és érdeklődési körrel rendelkező egyéneket kombinálnak:
| Írócsapat: A Piros Írókalapok | |
| Projekt: | Jelentés a jelenlegi állapotról elfedő technológiák |
| Csapattagok | Háttér, készségek, érdeklődések |
| Shawn S. | Villamosmérnöki szakon tanulok, jelenleg alapvető irodai adminisztratív feladatokat végzek egy ügyvédi irodában. |
| Tracey K. | Végzős angol szakos hallgató, remélve, hogy ez a kurzus segít a munkavállalási kilátások javításában. |
| Sanjiv Gupta | Informatika szakon tanulok, jelenleg számítógépes grafikát csinálok egy szoftverfejlesztő cégnél. |
| Jeon Chang Yeon | Hamarosan villamosmérnök szakon tanuló, még mindig fejleszti az angol nyelvi készségeit. |
| Alice B. | Nem nyilvánított szak, nem technikai fókusz, lehet, hogy rossz kurzusban, nincsenek megadott készségek. |
A projekt tervezése. Miután összeállítottad az írócsapatodat, a munka nagy része ugyanolyan, mintha egyedül írnál—kivéve, hogy minden fázis csapatmunka. Kifejezetten találkozz a csapatoddal, hogy eldöntsétek vagy megtervezzétek a következőket:
Tervezési Szakaszok
|
Rögzítse csapata profilját és döntéseit egy egyszerű csapat-terv dokumentum. Tartalmazhatja a csapat ütemtervének kuldateleit, a csapat által készült dokumentum tervezetét, a formázási megállapodásokat, az egyes írók megbízásait, a szószedet preferenciáit stb. Lent említésre kerül egy alapszabály dokumentum. Az is beépíthető a csapat tervébe.
A csapatírás projekt során a munka nagy részét az egyéni csapattagoknak önállóan kell elvégezniük. Ha azonban a csapat úgy dönt, hogy megosztja a munkát az írási projekthez, próbálja meg betartani legalább ezeket a minimális irányelveket:
- Minden csapattag legyen felelős a dokumentum egy jelentős szakaszának megírásáért.
- Minden csapattag legyen felelős az információs források egyenlő részének felkutatásáért, elolvasásáért és jegyzeteléséért.
A projekt egyes feladatait, amelyeket csapatban el lehet végezni, érdemes lehet először egyedül elvégezni. Például a gondolatébresztés, a szűkítés és különösen a vázlatkészítés először minden csapattag által önállóan történjen; majd összeülekezve hasonlítsák össze a jegyzeteiket. Ne feledje, hogy a csoportdinamika hogyan tud akaratlanul is elnyomni bizonyos ötleteket, és hogy a kevésbé határozott csapattagok esetleg vonakodnak megosztani értékes ötleteiket a csoportos környezetben.
Miután felosztottátok a munka feladatait a projekthez, írjatok egy hivatalos táblázatot, és osszátok szét azt minden tag között.
Diagram a írót csapat tagjainak felelősségeit a projekthez
A projekt ütemezése és a munkaterhelés egyensúlyának megteremtése. A csapatírási projekted elején állíts össze egy kulcsfontosságú dátumokat tartalmazó ütemtervet. Ez az ütemterv lehetővé teszi számodra és csapattársaid számára, hogy folyamatos, szervezett előrehaladást érjetek el és időben befejezzétek a projektet. Az alábbi példa ütemtervvel összhangban ne csak a projekt kulcsfontosságú fázisainak befejezési dátumait tartalmazd, hanem a megbeszélések dátumait, valamint azok témáját és célját is. Figyeld meg ezeket a részleteket az ütemtervvel kapcsolatban:
- Több találkozót terveznek, ahol a tagok megvitatják az általuk megtalált vagy nem megtalált információkat. (Az egyik csapattagnak lehet olyan információja, amit a másik tag mindenhol keres.)
- Több találkozó van ütemezve a projekt részleteinek áttekintésére, különösen a téma, a közönség, a cél, a helyzet és a vázlat tekintetében. Ahogy egyre többet megtudsz a témáról és egyre magabiztosabb leszel a projektben, a csapatod esetleg szeretne megváltoztatni néhány ilyen részletet vagy pontosabbá tenni azokat.
- Több vázlat van ütemezve. A csapattagok legalább kétszer átnézik egymás egyedi szakaszainak vázlatait, másodszor azért, hogy megnézzék, működtek-e a javasolt változtatások. Miután a teljes vázlat összeállt, azt is kétszer átnézik.
Csapatírási projekt ütemezése
Problémák előrejelzése és csapat szabályzatának létrehozása. Gondolj arra, hogyan lehet megoldani azokat a tipikus problémákat, amelyek egy csapatprojekt során felmerülhetnek, és dokumentáld a csapatod megállapodásait ezekről a kérdésekről egy belső szabályzat dokumentum:
- Munkahelyi terhelés egyensúlyhiánya. Amikor csapatban dolgozol, mindig van lehetőség arra, hogy az egyik csapattag, bármilyen okból, többet vagy kevesebbet vállaljon a munkából. Ezért fontos, hogy találj módot arra, hogy nyomon kövesd, mit csinál minden csapattag. Egy jó módszer erre, ha az egyes csapattagok naplót vagy nyilvántartást vezetnek arról, hogy milyen típusú munkát végeznek és mennyi időt töltenek el vele.
A projekt során és annak végén, ha bármilyen probléma adódik, a napló ezt nagyon világosan jelezze, és lehetővé tegye a munkaterhek méltányosabb elosztását. A projekt végén a csapattagok összesíthetik a projekt során eltöltött óráikat; ha valaki kicsit többet dolgozott a részidejénél, a többi tag ezt kompenzálhatja azzal, hogy meghívja vacsorára vagy ad neki valamilyen jutalmat. Hasonlóképpen, ahogy közeledünk a projekt végéhez, ha a naplókból kiderül, hogy az egyik csapattag munkakötelezettségei, akármennyire is nem az ő hibájából, kisebbek voltak, mint a többieké, ezt kompenzálhatja azzal, hogy több befejező munkát végez, mint például írás, korrektúrázás vagy másolás. - A csapattagok releváns készségek nélkül. Ahogyan az példában látható a csapattagok készségeivel kapcsolatban, az egyik tagnak nincsenek releváns készségei, amikkel hozzájárulhatna a projekthez. Néha ez csak az adott személy szorongásának vagy érdektelenségének jele a csoportos projektek iránt. Természetesen minden csapattagnak egy íráskurzusban kell, hogy igazságos részesedéssel járuljon hozzá a projekt írásához. Azonban számos olyan feladat létezik, amely nem igényel technikai tudást, formázási készségeket vagy éles szerkesztői szemet, például: a csapat tervének, a szabályzatnak, a csapatülések jegyzőkönyvének megírása és terjesztése; emlékeztetni a csapattagokat a határidőkre és a tervezett ülésekre. Valójában, a szorongás vagy érdektelenség kivételével, a magát ügyetlennek valló csapattag lehet a legjobb csapatvezető!
- Eltűnő csapattagok. Ha a csapatod olyan szerencsétlen helyzetbe kerül, hogy van egy felelőtlen tagja, aki egyszerűen eltűnik, legyen egy terved arra, hogy mit tegyél az ügyben, és dokumentáld ezt a csapat szabályaiban. Egy nyilvánvaló megoldás, hogy kitaszítod a csapat tagját, és értesíted az oktatót, ha írói kurzusról van szó, vagy a következő szintű vezetőséget, ha nem akadémiai szervezetről van szó.
- Látszólag megkövesedett csapattagok közötti nézeteltérések. Fantasztikus, hogy a csapat tagjai mennyire hevesen tudnak eltérni a csapatírási projektek bizonyos aspektusaitól. Legyen egy terv, amelyet a csapat alapszabályaiban rögzítenek, hogyan kell ezeket a kérdéseket megoldani. Szavazásra kell bocsátani őket? Vagy "escalálni" kell az ügyet egy semleges vagy magasabb szintű félhez?
- Radikálisan következetlen írásmódok és formátumok. Mivel az egyes szakaszokat különböző írók írják, akik hajlamosak eltérő írási stílusokra, állítsanak össze egy stílusguiát, amelyben a csapattagok felsorolják azokat a megállapodásaikat, hogy az egész dokumentumban hogyan kellene kezelni a dolgokat. Ezek a megállapodások terjedhetnek a magas szinttől, például attól, hogy legyen-e háttérszakasz, egészen a részletekig, például mikor használjunk dőlt betűt vagy vastag betűt, és hogy "kattintás" vagy "kattints rá". Lásd az alábbi részletet egy projekt stíluslapból. Ezen elemek megbeszéléséhez lásd stíluslapok és stílus útmutatók.
Mielőtt te és csapatod tagjai megírjátok az első vázlatokat, nem várhatod el, hogy minden lehetséges stílusbeli és formátumbeli eltérést előre lássatok. Ezért tervezd meg, hogy frissíted ezt a stíluslapot, amikor áttekinted az egyes szakaszok vázlatait, és különösen, amikor az egész vázlatot átnézed.
Részlet egy stíluskalauzból egy írási projekthez. Az itt felsorolt tételek a csapat írói által hozott megállapodásokat képviselik, hogy a dokumentumuk lehető legnagyobb mértékben konzisztens legyen.
Tervezet átnézése és befejezése. Próbálj meg annyi visszajelzést ütemezni, amennyit csak lehet a csapatod írásos munkájáról. Találkozhattok, hogy megbeszéljétek egymás egyes szakaszainak vázlatait, valamint a teljes dokumentum vázlatát is. Amikor találkoztok, kövessétek a korábbi szakaszban tárgyalt, illetve a kollégák átnézésére vonatkozó javaslatokat. Párhuzamos bírálati stratégiák.
A csapatírás kritikus szakasza akkor következik el, amikor a különböző csapattagok által írt egyes részeket egy teljes tervezetbe összeállítod. Ekkor valószínűleg észre fogod venni, mennyire eltérő a hangvétel, a kezelés és a stílus minden egyes részben. Csoportként el kell döntenetek, hogyan javítsátok és szerkesszétek meg a teljes vázlatot, hogy az következetesen olvasható legyen, és ne tűnjön annyira nyilvánvalónak, hogy három vagy négy különböző ember írta.
Amikor befejezted a felülvizsgálatot és a módosítást, itt az ideje, hogy befejezd a munkát, hogy a vázlatot készen állj leadni. Ez a munka ugyanaz, mint amikor egyedül írnád a dokumentumot, csak ebben az esetben a munkaterhek megoszthatók.
Kapcsolódó információk
A Dokumentáció Word-ben Történő Átnézésének Igazi Költsége. clickhelp.com
Értékelném a gondolataidat, reakcióidat, kritikádat ezzel a fejezettel kapcsolatban: a válaszod—David McMurrey.
