Por favor, clique aqui para ajudar David McMurrey pague pela hospedagem na web:
Doe qualquer quantia pequena que puder!
A Escrita Técnica Online continuará gratuita.
Revisão por pares (também chamado de revisão por pares) significa pessoas se reunindo para ler, comentar e recomendar melhorias no trabalho umas das outras. A revisão por pares é uma boa maneira de se tornar um escritor melhor: proporciona experiência em olhar criticamente para a escrita. A revisão por pares também é uma ótima maneira de melhorar projetos de escrita.
Escrita em equipe, como o nome indica, significa pessoas se reunindo para planejar, escrever e revisar projetos de escrita em grupo ou equipe. Outro nome para essa prática é escrita colaborativa—escrita colaborativa que está exposta em vez de oculto (onde é conhecido como plágio).
Esteja ciente de que, nos últimos anos, aplicativos de software para projetos em equipe surgiram, sendo o Atlassian Confluence um dos mais populares. Ele oferece espaços para que os membros da equipe tenham escritórios, espaços para realizar reuniões de equipe, mecanismos para rastrear documentos e mais. Um curso online está disponível na McMurrey Associates: Cursos em Comunicação Técnica. Projetos da Equipe de Redação Técnica do Confluence
Estratégias para Revisão por Pares
Quando você faz a revisão por pares do trabalho de outro escritor, você o avalia, critica, sugere melhorias e então comunica tudo isso ao escritor. Como um revisor novato, você pode se sentir um pouco apreensivo em criticar o trabalho de outra pessoa. Por exemplo, como você diz a alguém que o ensaio dele é chato? Leia a discussão a seguir; você encontrará conselhos e diretrizes sobre como fazer revisões por pares e comunicar comentários de revisão por pares.
Reunião inicial. No início de uma revisão por pares, o escritor deve fornecer aos revisores anotações sobre a tarefa de escrita e sobre os objetivos e preocupações em relação ao projeto de escrita (tópico, público, propósito, situação, tipo), e alertá-los sobre quaisquer problemas ou preocupações. Como escritor, você quer alertar os revisores sobre esses problemas; deixe claro quais tipos de coisas você estava tentando fazer. Da mesma forma, os revisores devem pedir aos escritores cujos trabalhos estão revisando que forneçam informações sobre seus objetivos e preocupações. As perguntas da revisão por pares devem ser específicas, como as seguintes:
A minha explicação sobre a máquina virtual faz sentido para você? Faz sentido para nossos clientes menos técnicos?
Em geral, meu estilo de escrita é muito técnico? (Posso ter imitado demais as especificações dos engenheiros.)
Os títulos e subtítulos dos capítulos são indicativos o suficiente do conteúdo a seguir? (Tive dificuldade em formular alguns deles.)
As capturas de tela estão claras o suficiente? (Pode ser que eu estivesse tentando obter detalhes demais em algumas delas.)
Estratégias de revisão por pares. Ao revisar o trabalho de outras pessoas, lembre-se acima de tudo que você deve considerar todos os aspectos desse texto, não apenas—na verdade, menos ainda—a gramática, ortografia e pontuação. Se você é novo na revisão por pares, pode esquecer de revisar o rascunho para coisas como as seguintes:
- Certifique-se de que sua avaliação seja abrangente. Considere todos os aspectos do rascunho que você está revisando, não apenas a gramática, pontuação e ortografia.
- Leia o rascunho várias vezes, procurando uma gama completa de áreas problemáticas potenciais:
- Nível de interesse, adaptação ao público
- Persuasão, propósito
- Conteúdo, organização
- Clareza da discussão
- Coerência, use transições
- Título, introdução e conclusão.
- Estilo de frase e clareza
- Manipulação de gráficos
- Tenha cuidado ao fazer comentários ou críticas que se baseiem no seu próprio estilo pessoal. Fundamente suas críticas e sugestões de melhorias em diretrizes, conceitos e regras geralmente aceitas. Se você fizer um comentário que seja realmente uma preferência pessoal, explique-o.
- Explique completamente os problemas que você encontra. Não diga apenas que um documento "parece desorganizado". Explique o que está desorganizado no documento. Use detalhes específicos do rascunho para demonstrar seu ponto de vista.
- Sempre que você criticar algo no rascunho do escritor, tente sugerir alguma maneira de corrigir o problema. Não basta dizer ao escritor que seu documento parece desorganizado, por exemplo. Explique como esse problema pode ser resolvido.
- Baseie seus comentários e críticas em diretrizes, conceitos, princípios e regras aceitas. Não é suficiente dizer a um escritor que dois parágrafos deveriam ser trocados, por exemplo. Declare o motivo: informações mais gerais e introdutórias devem vir primeiro, por exemplo.
- Evite reescrever o rascunho que você está revisando. Em seus esforços para sugerir melhorias e correções, não exagere e reescreva o rascunho você mesmo. Fazer isso retira a propriedade do documento do escritor e tira do escritor a oportunidade de aprender e melhorar como escritor.
- Encontre coisas positivas e encorajadoras para dizer sobre o rascunho que você está revisando. Elogios, mesmo os pequenos, são geralmente muito apreciados. Leia o rascunho pelo menos uma vez, procurando coisas que foram bem feitas, e então informe o escritor sobre elas.
Resumo da revisão por pares. Uma vez que você tenha terminado uma revisão por pares, é uma boa ideia escrever um resumo de seus pensamentos, observações, impressões, críticas ou sentimentos sobre o rascunho. Veja a nota do revisor abaixo, que resume observações sobre um rascunho. Observe na nota alguns dos seguintes detalhes:
- Os comentários são categorizados de acordo com o tipo de problema ou erro—comentários de gramática e uso em um grupo; comentários de nível superior sobre temas como conteúdo, organização e nível de interesse em outro grupo.
- A importância relativa dos grupos de comentários é indicada. O revisor indica quais sugestões seriam "boas" de incorporar e quais são críticas para o sucesso do projeto de escrita.
- A maioria dos comentários inclui alguma declaração breve de diretrizes, regras, exemplos ou bom senso. O revisor não simplesmente diz "Isto está errado; conserte." Ele também explica a base do comentário.
- As perguntas são dirigidas ao escritor. O revisor está verificando se o escritor realmente quis afirmar ou insinuar certas coisas.
- O avaliador inclui comentários positivos sobre o rascunho e encontra maneiras não antagônicas e simpáticas de expressar críticas.
Trecho de uma nota resumindo os resultados de uma avaliação por pares. Dedique um tempo para resumir seus comentários sobre a revisão por pares em uma breve nota para o escritor. Seja o mais diplomático e solidário possível!
Estratégias para Escrita em Equipe
Como mencionado anteriormente neste capítulo, a escrita em equipe é uma das maneiras comuns pelas quais pessoas nos mundos dos negócios, governo, ciência e tecnologia lidam com grandes projetos de escrita.
Infográfico gerado pelo NotebookLM deste capítulo
Reunindo a equipe. Quando você começar a escolher membros da equipe para um projeto de escrita em um curso de redação técnica, escolha pessoas com diferentes formações e interesses. Assim como uma formação diversificada e equilibrada para um escritor individual é uma vantagem, um grupo de indivíduos diversos forma uma equipe de escrita completa.
Se você é o líder da equipe, pode até pedir aos possíveis membros da equipe suas origens, interesses, cursos, talentos e aptidões. As seguintes equipes de escrita combinam indivíduos com origens e interesses diversos:
| Equipe de escrita: As Capuzes Vermelhos | |
| Projeto: | Um relatório sobre o atual tecnologias de camuflagem |
| Membros da equipe | Formação, habilidades, interesses |
| Shawn S. | Graduado em engenharia elétrica, atualmente realizando tarefas básicas de gerenciamento de escritório em um escritório de advocacia. |
| Tracey K. | Graduado em inglês, espero que este curso ajude nas perspectivas de emprego |
| Sanjiv Gupta | Graduado em ciência da computação, atualmente trabalhando com gráficos de computador em uma empresa de desenvolvimento de software. |
| Jeon Chang Yeon | Futuro aluno de engenharia elétrica, ainda desenvolvendo habilidades no idioma inglês. |
| Alice B. | Curso não declarado com foco não técnico, possivelmente no curso errado, sem habilidades declaradas. |
Planejando o projeto. Uma vez que você tenha montado sua equipe de redação, a maior parte do trabalho é a mesma que seria se você estivesse escrevendo sozinho—exceto que cada fase é um esforço conjunto. Especificamente, reúna-se com sua equipe para decidir ou planejar o seguinte:
Etapas de Planejamento
|
Capture os perfis e decisões da sua equipe de forma simples. documento de plano de equipe. Ele pode conter as datas-chave no cronograma da equipe, uma estrutura provisória do documento a ser produzido pela equipe, acordos de formatação, atribuições de escritores individuais, preferências de escolha de palavras, e assim por diante. Menciona-se abaixo um documento de regulamentos internos. Isso também pode ser incorporado ao plano da equipe.
Grande parte do trabalho em um projeto de escrita em equipe deve ser realizada por membros individuais da equipe de forma independente. No entanto, se sua equipe decidir dividir o trabalho para o projeto de escrita, tente seguir pelo menos estas diretrizes mínimas:
- Faça com que cada membro da equipe seja responsável pela redação de uma seção principal do documento.
- Cada membro da equipe deve ser responsável por localizar, ler e fazer anotações sobre uma parte igual das fontes de informação.
Parte do trabalho para o projeto que poderia ser feito em equipe você pode querer fazer primeiro de forma independente. Por exemplo, a geração de ideias, o foco e, especialmente, o esboço devem ser feitos primeiro por cada membro da equipe por conta própria; depois, se reunir e comparar anotações. Lembre-se de como a dinâmica de grupo pode, sem querer, suprimir certas ideias e como membros da equipe menos assertivos podem hesitar em contribuir com suas valiosas ideias no contexto do grupo.
Após dividir o trabalho para o projeto, elabore um gráfico formal e distribua-o a todos os membros.
Gráfico listando as responsabilidades dos membros da equipe de redação para o projeto
Agendamento do projeto e balanceamento da carga de trabalho. No início do seu projeto de redação em equipe, estabeleça um cronograma com datas importantes. Este cronograma permitirá que você e seus membros da equipe façam progressos constantes e organizados e completem o projeto a tempo. Como mostrado no cronograma de exemplo abaixo, inclua não apenas as datas de conclusão das fases chave do projeto, mas também as datas das reuniões e o assunto e a finalidade dessas reuniões. Observe estes detalhes sobre esse cronograma:
- Várias reuniões estão agendadas nas quais os membros discutem as informações que estão encontrando ou não encontrando. (Um membro da equipe pode ter informações que outro membro está procurando em todo lugar.)
- Várias reuniões estão agendadas para revisar os detalhes do projeto, especificamente, o tópico, o público, o propósito, a situação e o esboço. À medida que você aprende mais sobre o tópico e se estabelece mais no projeto, sua equipe pode querer mudar alguns desses detalhes ou torná-los mais específicos.
- Vários rascunhos estão programados. Os membros da equipe revisam os rascunhos uns dos outros de seções individuais pelo menos duas vezes, a segunda para verificar se as mudanças recomendadas funcionaram. Uma vez que o rascunho completo é montado, ele também é revisado duas vezes.
Cronograma para um projeto de redação em equipe
Antecipando problemas e criando regras para a equipe. Pense em como resolver problemas típicos que podem surgir em um projeto em equipe e documente os acordos de sua equipe sobre essas questões em um documento de regulamentos internos:
- Desbalanceamento de carga de trabalho. Quando você trabalha em equipe, sempre há a chance de que um dos membros da equipe, por qualquer motivo, possa ter mais ou menos do que sua parte justa da carga de trabalho. Portanto, é importante encontrar uma maneira de acompanhar o que cada membro da equipe está fazendo. Uma boa maneira de fazer isso é fazer com que os membros individuais da equipe mantenham um diário ou registro do tipo de trabalho que realizam e quanto tempo passam fazendo isso.
Tanto durante quanto ao final do projeto, se houver algum problema, o diário deve deixar isso muito claro e permitir um equilíbrio mais equitativo da carga de trabalho. Ao final do projeto, os membros da equipe podem somar as horas gastas no projeto; se alguém tiver passado um pouco mais do que sua parte de tempo trabalhando, os outros membros podem compensar isso comprando-lhe o jantar ou alguma recompensa assim. Da mesma forma, conforme você se aproxima do final do projeto, se estiver claro pelos diários que as responsabilidades de trabalho de um membro da equipe acabaram, sem culpa dele, sendo menores do que as dos outros, ele pode compensar isso fazendo mais trabalho de finalização, como digitar, revisar ou copiar. - Membros da equipe sem habilidades relevantes. Como você pode ver na descrição de habilidades dos membros da equipe acima, um dos membros não possui habilidades relevantes para contribuir com o projeto. Às vezes, isso é apenas uma indicação da ansiedade dessa pessoa ou da falta de interesse em participar de um projeto em grupo. Claro, cada membro da equipe em um curso de escrita deve contribuir uma parte justa da redação para um projeto. No entanto, existem muitas tarefas que não exigem conhecimento técnico, habilidades de formatação ou um olhar editorial afiado, por exemplo: digitar e distribuir o plano da equipe, o regulamento, as atas das reuniões da equipe; lembrar os membros da equipe sobre prazos e reuniões agendadas. Na verdade, exceto pela ansiedade ou falta de interesse, o membro da equipe que se declara não habilidoso pode ser o melhor líder da equipe!
- Membros da equipe desaparecendo. Se sua equipe é tão infeliz a ponto de ter um membro irresponsável que simplesmente desaparece, tenha um plano sobre o que fazer a respeito e documente isso nas regras da sua equipe. Uma solução óbvia é expulsar o membro da equipe e informar o instrutor se for um curso de escrita ou o próximo nível de gestão se for uma organização não acadêmica.
- Desacordos entre membros da equipe aparentemente enraizados. É incrível como os membros da equipe podem discordar veementemente sobre aspectos de um projeto de escrita em equipe. Tenham um plano, escrito em seus estatutos, sobre como resolver essas questões. Devem ser colocadas em votação? Vocês devem "escalar" a questão para uma parte neutra ou de nível superior?
- Estilos de escrita e formatação radicalmente inconsistentes. Porque as seções individuais serão escritas por diferentes autores que podem ter estilos de escrita variados, estabeleça um guia de estilo no qual os membros da sua equipe listem seus acordos sobre como as coisas devem ser tratadas no documento como um todo. Esses acordos podem variar do nível alto, como a inclusão de uma seção de contexto, até detalhes minuciosos, como quando usar itálico ou negrito e se é "clique" ou "clique em." Veja o trecho de uma folha de estilo do projeto a seguir. Para discussão desses itens, veja folhas de estilo e guias de estilo.
Antes de você e os membros da sua equipe escreverem os primeiros rascunhos, não se pode esperar antecipar todas as possíveis diferenças de estilo e formato. Portanto, planeje atualizar este guia de estilo quando você revisar os rascunhos das seções individuais e, especialmente, quando revisar o rascunho completo.
Trecho de um guia de estilo para um projeto de escrita. Os itens listados representam acordos que os escritores da equipe fizeram para dar ao seu documento o máximo de consistência possível.
Revisando rascunhos e finalizando. Tente agendar o maior número possível de revisões do trabalho escrito de sua equipe. Você pode se reunir para discutir os rascunhos de cada seção individual, bem como os rascunhos do documento completo. Quando se reunirem, sigam as sugestões para edição entre pares discutidas na seção anterior deste capítulo. Estratégias para revisão por pares.
Uma etapa crítica na redação em equipe de um documento ocorre quando você junta em um rascunho completo as seções individuais escritas por diferentes membros da equipe. É então que você provavelmente verá o quão diferentes em tom, abordagem e estilo cada seção é. Vocês devem, como grupo, encontrar uma maneira de revisar e editar o rascunho completo que o faça ler de forma consistente, para que não fique tão evidente que foi escrito por três ou quatro pessoas diferentes.
Quando você terminar de revisar e revisar, é hora de fazer o trabalho final para deixar o rascunho pronto para ser entregue. Esse trabalho é o mesmo que seria se você estivesse escrevendo o documento sozinho, apenas neste caso as cargas de trabalho podem ser divididas.
Informações Relacionadas
Custo Real de Revisar Documentação no Word. clickhelp.com
Agradeceria suas opiniões, reações e críticas sobre este capítulo: sua resposta—David McMurrey.
