Klik hier om te helpen David McMurrey betaal voor webhosting:
Doneer elk klein bedrag dat je kunt!
Online technische documentatie blijft gratis.
Peer reviewen (ook wel collegiale beoordeling genoemd) betekent dat mensen samenkomen om elkaars werk te lezen, commentaar te geven en verbeteringen aan te bevelen. Collegiale beoordeling is een goede manier om een betere schrijver te worden: het biedt ervaring in het kritisch kijken naar schrijven. Collegiale beoordeling is ook een geweldige manier om schrijfprojecten te verbeteren.
Team schrijven, zoals de naam aangeeft, betekent mensen die samenkomen om schrijfprojecten te plannen, te schrijven en te herzien als een groep of team. Een andere naam voor deze praktijk is collaboratief schrijven—collaboratief schrijven dat openlijk gebeurt in plaats van achter gesloten deuren (waar het bekend staat als plagiaat).
Wees ervan bewust dat in de afgelopen jaren teamprojectsoftware-applicaties zijn verschenen, waarbij Atlassian Confluence een populaire is. Het biedt ruimtes voor teamleden om kantoren te hebben, ruimtes om teamvergaderingen te houden, mechanismen om documenten te volgen, en meer. Een online cursus is beschikbaar bij McMurrey Associates: Cursussen in Technische Communicatie. Confluence Technisch-Schrijversteam Projecten
Strategieën voor Peer Reviewen
Wanneer je het werk van een andere schrijver beoordeelt, evalueer je het, bekritiseer je het, stel je verbeteringen voor, en communiceer je dat allemaal naar de schrijver. Als eerste keer beoordelende persoon kun je wat ongemakkelijk zijn over het bekritiseren van het werk van iemand anders. Bijvoorbeeld, hoe vertel je iemand dat zijn essay saai is? Lees de volgende bespreking; je zult advies en richtlijnen vinden over het doen van peer reviews en het communiceren van peer-reviewcommentaar.
Eerste vergadering. Aan het begin van een peer review moet de schrijver de peer reviewers voorzien van notities over de schrijfopdracht en over doelen en zorgen met betrekking tot het schrijfproject (onderwerp, publiek, doel, situatie, type), en hen waarschuwen voor eventuele problemen of zorgen. Als schrijver wil je reviewers op deze problemen attenderen; maak duidelijk welke soorten zaken je probeerde te doen. Evenzo moeten peer reviewers schrijvers wiens werk ze peer-reviewen vragen om informatie over hun doelstellingen en zorgen. De peer-reviewvragen moeten specifiek zijn, zoals de volgende:
Maakt mijn uitleg over de virtuele machine zin voor jou? Zou het ook begrijpelijk zijn voor onze minst technische klanten?
Over het algemeen, is mijn schrijfstijl te technisch? (Ik heb misschien te veel de specificaties van de ingenieurs nagedaan.)
Zijn de hoofdstuktitels en kopjes voldoende indicatief voor de volgende inhoud? (Ik had moeite met het formuleren van sommige hiervan.)
Zijn de schermafbeeldingen duidelijk genoeg? (Ik heb misschien geprobeerd te veel detail in sommige daarvan te krijgen.)
Peer-reviewstrategieën. Wanneer je het schrijven van anderen beoordeelt, herinner je dan vooral dat je alle aspecten van dat schrijven in overweging moet nemen, niet alleen—in feite, het minst van alles—de grammatica, spelling en interpunctie. Als je nieuw bent in het beoordelen van teksten, kan het zijn dat je vergeet het concept te beoordelen op dingen zoals de volgende:
- Zorg ervoor dat je beoordeling uitgebreid is. Overweeg alle aspecten van het ontwerp dat je aan het beoordelen bent, niet alleen de grammatica, interpunctie en spelling.
- Lees het concept meerdere keren, op zoek naar een volledige reeks potentiële probleemgebieden:
- Interesse-niveau, aanpassing aan het publiek
- Overtuigingskracht, doel
- Inhoud, organisatie
- Duidelijkheid van de discussie
- Coherentie, gebruik overgangen
- Titel, inleiding en conclusie.
- Zinsstijl en helderheid
- Omgang met graphics
- Wees voorzichtig met het maken van opmerkingen of kritiek die gebaseerd zijn op je eigen persoonlijke stijl. Baseer je kritiek en suggesties voor verbeteringen op algemeen aanvaarde richtlijnen, concepten en regels. Als je een opmerking maakt die echt jouw persoonlijke voorkeur is, leg dat dan uit.
- Leg de problemen die je tegenkomt volledig uit. Zeg niet alleen dat een document "ontzettend ongeorganiseerd" lijkt. Leg uit wat er ongeorganiseerd is aan het document. Gebruik specifieke details uit het concept om je standpunt te onderbouwen.
- Elke keer als je iets in de concept van de schrijver bekritiseert, probeer dan een manier voor te stellen om het probleem op te lossen. Het is niet genoeg om de schrijver te vertellen dat haar document, bijvoorbeeld, als ongeorganiseerd lijkt. Leg uit hoe dat probleem opgelost kan worden.
- Baseer je opmerkingen en kritiek op aanvaarde richtlijnen, concepten, principes en regels. Het is niet voldoende om een schrijver te vertellen dat twee alinea's omgeruild moeten worden, bijvoorbeeld. Noem de reden waarom: meer algemene, inleidende informatie zou eerst moeten komen, bijvoorbeeld.
- Vermijd het herschrijven van het concept dat je aan het beoordelen bent. In je pogingen om verbeteringen en correcties voor te stellen, moet je niet overdrijven en het concept zelf herschrijven. Dit neemt de eigenaarschap van het document weg van de schrijver en ontneemt de schrijver de kans om te leren en zich te verbeteren als schrijver.
- Vind positieve, bemoedigende dingen om te zeggen over het concept dat je aan het beoordelen bent. Complimenten, zelfs kleine, worden meestal enorm gewaardeerd. Lees het concept minstens één keer door op zoek naar dingen die goed zijn gedaan, en laat de schrijver daarover weten.
Peer-review samenvatting. Zodra je een collegiaal oordeel hebt afgerond, is het een goed idee om een samenvatting te schrijven van je gedachten, observaties, indrukken, kritieken of gevoelens over de ruwe versie. Zie de onderstaande opmerking van de peer-reviewer, die observaties over een ruwe versie samenvat. Let op in de opmerking op enkele van de volgende details:
- De opmerkingen zijn gecategoriseerd op basis van het type probleem of fout—grammatica- en gebruiksopmerkingen in één groep; opmerkingen op een hoger niveau, zoals inhoud, organisatie en interesse-niveau in een andere groep.
- De relatieve importantie van de groepen opmerkingen wordt aangegeven. De peer-reviewer geeft aan welke suggesties "leuk" zouden zijn om op te nemen, en welke cruciaal zijn voor het succes van het schrijfproject.
- De meeste opmerkingen bevatten een korte verklaring van richtlijnen, regels, voorbeelden of gezond verstand. De beoordelaar zegt niet gewoon "Dit is fout; los het op." Hij legt ook de basis voor de opmerking uit.
- Vragen worden aan de schrijver gericht. De recensent controleert of de schrijver echt bedoelde bepaalde dingen te stellen of te impliceren.
- De beoordelaar geeft positieve opmerkingen over het concept en vindt niet-antagonistische, sympathieke manieren om kritiek te uiten.
Uittreksel uit een aantekening die de resultaten van een beoordelingsronde samenvat. Neem wat tijd om je feedback van de peer-review samen te vatten in een korte notitie aan de schrijver. Wees zo diplomatiek en empathisch als je kunt!
Strategieën voor Team Schrijven
Zoals eerder in dit hoofdstuk genoemd, is team schrijven een van de gebruikelijke manieren waarop mensen in de wereld van het bedrijfsleven, de overheid, de wetenschap en technologie grote schrijfprojecten aanpakken.
NotebookLM-geproduceerde infographic van dit hoofdstuk
Het samenstellen van het team. Wanneer je begint met het kiezen van teamleden voor een schrijproject in een cursus technisch schrijven, kies dan mensen met verschillende achtergronden en interesses. Net zoals een diverse, breed georiënteerde achtergrond voor een individuele schrijver een voordeel is, zorgt een groep van diverse individuen voor een evenwichtig schrijfteam.
Als je de teamleider bent, kun je zelfs potentiële teamleden vragen naar hun achtergrond, interesses, studierichtingen, talenten en vaardigheden. De volgende schrijfteams combineren individuen met diverse achtergronden en interesses:
| Schrijfteam: De Rode Schrijfmutsen | |
| Project: | Een rapport over de huidige camouflage-technologieën |
| Teamleden | Achtergronden, vaardigheden, interesses |
| Shawn S. | Studie Electrical Engineering, momenteel basis kantoorbeheer taken uitvoerend bij een advocatenkantoor. |
| Tracey K. | Senior Engelse major, hopend dat deze cursus helpt bij de werkgelegenheidsperspectieven. |
| Sanjiv Gupta | Informatica student, momenteel bezig met computergraphics bij een softwareontwikkelingsbedrijf. |
| Jeon Chang Yeon | Bijna afgestudeerd in de elektrotechniek, nog steeds bezig met het ontwikkelen van Engelse taalvaardigheden |
| Alice B. | Onbepaalde major met een niet-technische focus, mogelijk in de verkeerde cursus, geen vermelde vaardigheden |
Het plannen van het project. Zodra je je schrijfteam hebt samengesteld, is het merendeel van het werk hetzelfde als wanneer je alleen zou schrijven—behalve dat elke fase een teaminspanning is. Bespreek specifiek met je team om het volgende te beslissen of te plannen:
Planningsfases
|
Leg de profielen en besluiten van je team vast in een eenvoudige team-plan document. Het kan de belangrijke data in de teamplanning bevatten, een voorlopige opzet van het document dat door het team geproduceerd moet worden, afspraken over opmaak, individuele schrijfopdrachten, voorkeuren voor woordkeuze, enzovoort. Hieronder wordt melding gemaakt van een reglementdocument. Dat kan ook in het teamplan worden opgenomen.
Een groot deel van het werk in een team-schrijproject moet door individuele teamleden alleen worden gedaan. Als je team echter besluit het werk voor het schrijfproject te verdelen, probeer dan tenminste deze minimale richtlijnen:
- Laat elk teamlid verantwoordelijk zijn voor het schrijven van één belangrijke sectie van het document.
- Laat elk teamlid verantwoordelijk zijn voor het vinden, lezen en maken van aantekeningen over een gelijk deel van de informatiebronnen.
Een deel van het werk voor het project dat als team gedaan kan worden, wil je misschien eerst onafhankelijk doen. Bijvoorbeeld, brainstormen, verfijnen en vooral het opstellen van een structuur zou eerst door elk teamlid alleen moeten gebeuren; daarna samenkomen en aantekeningen vergelijken. Houd rekening met hoe groepsdynamiek onbewust bepaalde ideeën kan onderdrukken en hoe minder assertieve teamleden mogelijk terughoudend zijn om hun waardevolle ideeën in de groepscontext bij te dragen.
Nadat je het werk voor het project hebt verdeeld, schrijf je een formele tabel en distribueer je deze naar alle leden.
Grafiek met de verantwoordelijkheden van de leden van het schrijvers team voor het project
Het plannen van het project en het balanceren van de werklast. Aan het begin van je team schrijproject, stel een schema op met belangrijke datums. Dit schema stelt jou en je teamleden in staat om gestaag, georganiseerd vooruitgang te boeken en het project op tijd te voltooien. Zoals te zien is in het onderstaande voorbeeldschema, vermeld niet alleen de voltooiingsdata voor belangrijke fasen van het project, maar ook vergaderdatums en het onderwerp en doel van die vergaderingen. Let op deze details over dat schema:
- Er zijn verschillende vergaderingen gepland waarin leden de informatie bespreken die ze vinden of niet vinden. (Een teamlid heeft misschien informatie waar een ander lid overal naar op zoek is.)
- Er zijn verschillende vergaderingen gepland om de projectdetails te bespreken, specifiek het onderwerp, het publiek, het doel, de situatie en de opzet. Naarmate je meer te weten komt over het onderwerp en meer vertrouwd raakt met het project, wil je team mogelijk enkele van deze details wijzigen of specifieker maken.
- Er zijn verschillende ruwe versies gepland. Teamleden beoordelen elkaars versies van individuele secties minstens twee keer, de tweede keer om te zien of de aanbevolen wijzigingen zijn doorgevoerd. Zodra de volledige versie is samengesteld, wordt ook deze twee keer beoordeeld.
Schema voor een team schrijfproject
Problemen anticiperen en teamstatuten opstellen. Denk na over hoe je typische problemen kunt oplossen die zich kunnen voordoen in een teamproject en documenteer de afspraken van je team over deze zaken in een statuten document:
- Werkbelasting onevenwichtigheid. Wanneer je als team werkt, is er altijd de kans dat een van de teamleden, om welke reden dan ook, meer of minder dan een eerlijk aandeel van de werklast heeft. Daarom is het belangrijk om een manier te vinden om bij te houden wat elk teamlid doet. Een goede manier om dat te doen is om individuele teamleden een dagboek of logboek bij te laten houden van het soort werk dat ze doen en hoeveel tijd ze eraan besteden.
Zowel tijdens als aan het einde van het project, als er problemen zijn, moet het journal die feitelijkheid duidelijk maken en een eerlijkere verdeling van de werklast mogelijk maken. Aan het einde van het project kunnen teamleden hun gewerkte uren optellen; als iemand iets meer tijd aan het project heeft besteed dan zijn of haar aandeel, kunnen de andere leden dat compenseren door haar of hem uit eten te nemen of een soortgelijke beloning. Evenzo, naarmate je dichter bij het einde van het project komt, als uit de journals blijkt dat de werkverantwoordelijkheden van een teamlid, zonder dat hij daar iets aan kon doen, kleiner bleken te zijn dan die van de anderen, kan hij dat compenseren door meer van het afwerkwerk te doen, zoals typen, proeflezen of kopiëren. - Teamleden zonder relevante vaardigheden. Zoals je kunt zien in de voorbeeldbeschrijving van de vaardigheden van teamleden hierboven, heeft één lid geen relevante vaardigheden om bij te dragen aan het project. Soms is dat gewoon een aanwijzing voor de angst van die persoon of gebrek aan interesse om deel te nemen aan een groepsproject. Natuurlijk zou elk teamlid in een schrijfcursus een eerlijk deel van het schrijven voor een project moeten bijdragen. Er zijn echter tal van taken die geen technische kennis, formatteringsvaardigheden of een scherp redactioneel oog vereisen, bijvoorbeeld: het opstellen en verspreiden van het teamplan, de statuten, notulen van teamvergaderingen; teamleden herinneren aan deadlines en geplande vergaderingen. In feite, afgezien van de angst of gebrek aan interesse, zou het zelfverklaarde ongeschikte teamlid wel eens de beste teamleider kunnen zijn!
- Verdwijnende teamleden. Als je team zo ongelukkig is om een onverantwoordelijke lid te hebben die gewoon verdwijnt, heb dan een plan voor wat te doen en documenteer dit in je teamstatuten. Een voor de hand liggende oplossing is om het teamlid uit het team te zetten en de instructeur te informeren als het een schrijfcursus is, of het volgende niveau van management als het een niet-academische organisatie is.
- Schijnbaar ingesleten meningsverschillen tussen teamleden. Het is verbazingwekkend hoe vuriger teamleden het oneens kunnen zijn over aspecten van een team schrijfproject. Heb een plan, vastgelegd in jullie teamstatuten, hoe deze zaken op te lossen. Moeten ze ter stemming worden voorgelegd? Moet je de kwestie "escaleren" naar een neutrale of hogere partij?
- Radicaal inconsistente schrijfstijlen en indelingen. Omdat de verschillende secties zullen worden geschreven door verschillende schrijvers met verschillende schrijfstijlen, stel een stijlgids op waarin teamleden hun afspraken opschrijven over hoe zaken in het document als geheel moeten worden behandeld. Deze afspraken kunnen variëren van het hoge niveau, zoals of er een achtergrondsectie moet zijn, tot aan specifieke details zoals wanneer cursief of vetgedrukt moet worden gebruikt en of het "klik" of "klik op" is. Zie het fragment van een projectstijlschrift hieronder. Voor discussie over deze items, zie stijlbladen en stijlrichtlijnen.
Voordat jij en je teamleden de eerste ruwe versies schrijven, kun je niet verwachten dat je elk mogelijk verschil in stijl en formaat kunt anticiperen. Plan daarom om dit stijlgids bij te werken wanneer je de ruwe versies van de individuele secties beoordeelt en, vooral, wanneer je de complete versie beoordeelt.
Fragment uit een stijlhandleiding voor een schrijfproject. De vermelde items vertegenwoordigen overeenkomsten die team schrijvers hebben gemaakt om hun document zoveel mogelijk consistentie te geven.
Concepten beoordelen en afronden. Probeer zoveel mogelijk beoordeling van het geschreven werk van je team in te plannen. Je kunt elkaar ontmoeten om elkaars ruwe versies van individuele secties te bespreken, evenals de ruwe versies van het complete document. Wanneer je elkaar ontmoet, volg dan de suggesties voor peer-editing die in de vorige sectie van dit hoofdstuk zijn besproken, Strategieën voor peer-reviewen.
Een cruciale fase in het gezamenlijk schrijven van een document komt wanneer je de afzonderlijke secties die door verschillende teamleden zijn geschreven, samenvoegt tot één complete versie. Het is dan dat je waarschijnlijk zult zien hoe verschillend van toon, behandeling en stijl elke sectie is. Jullie moeten als groep een manier vinden om de volledige ruwe versie te herzien en te bewerken, zodat deze consistent leest en niet zo duidelijk geschreven lijkt door drie of vier verschillende mensen.
Wanneer je klaar bent met het beoordelen en herzien, is het tijd voor het afrondingswerk om het concept klaar te maken voor inlevering. Dat werk is hetzelfde als wanneer je het document alleen zou schrijven, alleen kunnen in dit geval de werklasten worden verdeeld.
Gerelateerde Informatie
Werkelijke Kosten van het Beoordelen van Documentatie in Word. clickhelp.com
Ik zou uw gedachten, reacties en kritiek over dit hoofdstuk waarderen: je reactie—David McMurrey.
