Por favor, haga clic aquí para ayudar David McMurrey pagar por alojamiento web:
¡Dona cualquier pequeña cantidad que puedas!
La escritura técnica en línea seguirá siendo gratuita.
Revisión por pares (también llamado edición por pares) significa que las personas se reúnen para leer, comentar y recomendar mejoras en el trabajo de los demás. La revisión por pares es una buena manera de convertirse en un mejor escritor: proporciona experiencia en la evaluación crítica de la escritura. La revisión por pares también es una excelente manera de mejorar proyectos de escritura.
Escritura en equipo, como su nombre indica, significa que las personas se reúnen para planificar, escribir y revisar proyectos de escritura en grupo, o equipo. Otro nombre para esta práctica es escritura colaborativa—escritura colaborativa que es abierta en lugar de encubierta (donde se conoce como plagio).
Tenga en cuenta que en los últimos años han aparecido aplicaciones de software para proyectos en equipo, siendo Atlassian Confluence una de las más populares. Proporciona espacios para que los miembros del equipo tengan oficinas, espacios para llevar a cabo reuniones de equipo, mecanismos para rastrear documentos, y más. Hay un curso en línea disponible en McMurrey Associates: Cursos en Comunicación Técnica. Proyectos del Equipo de Redacción Técnica de Confluence
Estrategias para la Revisión por Pares
Cuando revisas el trabajo de otro escritor, lo evalúas, lo criticas, sugieres mejoras y luego comunicas todo eso al escritor. Como revisor por primera vez, podrías sentirte un poco incómodo criticando el trabajo de otra persona. Por ejemplo, ¿cómo le dices a alguien que su ensayo es aburrido? Lee la siguiente discusión; encontrarás consejos y pautas sobre cómo hacer revisiones por pares y comunicar los comentarios de la revisión por pares.
Reunión inicial. Al comienzo de una revisión entre pares, el escritor debe proporcionar a los revisores notas sobre la tarea de escritura y sobre los objetivos y preocupaciones respecto al proyecto de escritura (tema, audiencia, propósito, situación, tipo) y alertarlos sobre cualquier problema o inquietud. Como escritor, deseas alertar a los revisores sobre estos problemas; deja claro qué tipo de cosas intentabas hacer. Del mismo modo, los revisores deben pedir a los escritores cuyas obras están revisando que suministren información sobre sus objetivos y preocupaciones. Las preguntas de revisión entre pares deben ser específicas, como las siguientes:
¿Tiene sentido mi explicación de la máquina virtual para ti? ¿Tendría sentido para nuestros clientes menos técnicos?
En general, ¿es mi estilo de escritura demasiado técnico? (Puede que haya imitado demasiado las especificaciones de los ingenieros.)
¿Son los títulos de los capítulos y los encabezados lo suficientemente indicativos del contenido siguiente? (Tuve dificultades para formular algunos de estos.)
¿Son lo suficientemente claras las capturas de pantalla? (Puede que haya estado intentando captar demasiado detalle en algunas de ellas).
Estrategias de revisión por pares. Cuando revisas el trabajo de otras personas, recuerda sobre todo que debes considerar todos los aspectos de ese escrito, no solo—de hecho, menos aún—la gramática, la ortografía y la puntuación. Si eres nuevo en la revisión por pares, puede que olvides revisar el borrador por cosas como las siguientes:
- Asegúrate de que tu reseña sea completa. Considera todos los aspectos del borrador que estás revisando, no solo la gramática, la puntuación y la ortografía.
- Lee el borrador varias veces, buscando una gama completa de áreas problemáticas potenciales:
- Nivel de interés, adaptación a la audiencia
- Persuasión, propósito
- Contenido, organización
- Claridad de la discusión
- Coherencia, usar transiciones
- Título, introducción y conclusión.
- Estilo de oración y claridad
- Manejo de gráficos
- Ten cuidado al hacer comentarios o críticas que se basen en tu propio estilo personal. Basa tus críticas y sugerencias de mejora en pautas, conceptos y reglas generalmente aceptadas. Si realmente haces un comentario que es solo tu preferencia, explícalo.
- Explica completamente los problemas que encuentras. No digas simplemente que un documento "parece desorganizado". Explica qué es lo que está desorganizado en el documento. Utiliza detalles específicos del borrador para demostrar tu caso.
- Siempre que critiques algo en el borrador del escritor, intenta sugerir alguna manera de corregir el problema. No es suficiente decirle al escritor que su documento parece desorganizado, por ejemplo. Explica cómo se podría resolver ese problema.
- Base tus comentarios y críticas en pautas, conceptos, principios y reglas aceptadas. No es suficiente decirle a un escritor que dos párrafos deberían ser cambiados, por ejemplo. Explica la razón: la información más general e introductoria debería ir primero, por ejemplo.
- Evita reescribir el borrador que estás revisando. En tus esfuerzos por sugerir mejoras y correcciones, no te excedas y reescribas el borrador tú mismo. Hacerlo le quita al escritor la propiedad del documento y le roba la oportunidad de aprender y mejorar como escritor.
- Encuentra cosas positivas y alentadoras para decir sobre el borrador que estás revisando. Los cumplidos, incluso los pequeños, suelen ser muy apreciados. Lee el borrador al menos una vez buscando cosas que se hicieron bien, y luego informa al escritor sobre ellas.
Resumen de revisión por pares. Una vez que hayas terminado una revisión por pares, es una buena idea escribir un resumen de tus pensamientos, observaciones, impresiones, críticas o sentimientos sobre el borrador. Consulta la nota del revisor a continuación, que resume observaciones sobre un borrador. Nota en la nota algunos de los siguientes detalles:
- Los comentarios están categorizados según el tipo de problema o error—comentarios de gramática y uso en un grupo; comentarios de nivel superior, como contenido, organización e interés, en otro grupo.
- La importancia relativa de los grupos de comentarios está indicada. El revisor indica cuáles sugerencias sería "bonito" incorporar y cuáles son críticas para el éxito del proyecto de escritura.
- La mayoría de los comentarios incluyen alguna breve declaración de pautas, reglas, ejemplos o sentido común. El revisor no simplemente dice "Esto está mal; corrígelo." También explica la base del comentario.
- Las preguntas están dirigidas al escritor. El revisor está verificando si el escritor realmente quiso afirmar o insinuar ciertas cosas.
- El revisor incluye comentarios positivos sobre el borrador y encuentra formas no antagónicas y comprensivas de expresar críticas.
Extracto de una nota que resume los resultados de una revisión por pares. Dedique un tiempo a resumir sus comentarios de revisión por pares en una breve nota para el escritor. Sea lo más diplomático y comprensivo que pueda.
Estrategias para la Escritura en Equipo
Como se mencionó anteriormente en este capítulo, la escritura en equipo es una de las formas comunes en que las personas en los mundos de los negocios, el gobierno, la ciencia y la tecnología manejan grandes proyectos de escritura.
Infografía generada por NotebookLM de este capítulo
Formando el equipo. Cuando comienzas a elegir miembros del equipo para un proyecto de escritura en un curso de redacción técnica, elige personas con diferentes antecedentes e intereses. Así como un fondo diverso y bien equilibrado para un escritor individual es una ventaja, un grupo de individuos diversos forma un equipo de escritura completo.
Si eres el líder del equipo, incluso podrías preguntar a los posibles miembros del equipo sobre su formación, intereses, carreras, talentos y aptitudes. Los siguientes equipos de escritura combinan individuos con diversos antecedentes e intereses:
| Equipo de escritura: Las Capuchas Rojas | |
| Proyecto: | Un informe sobre la actualidad tecnologías de camuflaje |
| Miembros del equipo | Antecedentes, habilidades, intereses |
| Shawn S. | Estudiante de ingeniería eléctrica, actualmente realizando tareas básicas de gestión de oficina en un bufete de abogados. |
| Tracey K. | Estudiante de último año de inglés, esperando que este curso ayude con las perspectivas de empleo. |
| Sanjiv Gupta | Estudiante de informática, actualmente trabajando en gráficos por computadora en una empresa de desarrollo de software. |
| Jeon Chang Yeon | Próximo estudiante de ingeniería eléctrica, aún desarrollando habilidades en el idioma inglés. |
| Alicia B. | Carrera no declarada con un enfoque no técnico, posiblemente en el curso equivocado, sin habilidades declaradas |
Planificando el proyecto. Una vez que hayas reunido a tu equipo de escritura, la mayor parte del trabajo es el mismo que si estuvieras escribiendo solo—excepto que cada fase es un esfuerzo en equipo. Específicamente, reúnanse con su equipo para decidir o planificar lo siguiente:
Etapas de Planificación
|
Captura los perfiles y decisiones de tu equipo de manera sencilla. documento del plan del equipo. Puede contener las fechas clave en el calendario del equipo, un esquema tentativo del documento que se debe producir en equipo, acuerdos de formato, asignaciones de escritores individuales, preferencias de selección de palabras, y así sucesivamente. A continuación se menciona un documento de estatutos. Eso también puede ser incorporado en el plan del equipo.
Gran parte del trabajo en un proyecto de escritura en equipo debe ser realizado por los miembros del equipo de manera individual. Sin embargo, si su equipo decide dividir el trabajo para el proyecto de escritura, intente seguir al menos estas pautas mínimas:
- Haga que cada miembro del equipo sea responsable de la redacción de una sección importante del documento.
- Haga que cada miembro del equipo sea responsable de localizar, leer y tomar notas sobre una parte igual de las fuentes de información.
Algunos de los trabajos para el proyecto que podrían hacerse en equipo tal vez quieras hacerlos primero de manera independiente. Por ejemplo, la lluvia de ideas, definir el enfoque y, especialmente, el esquema deben ser realizados primero por cada miembro del equipo por su cuenta; luego reúnanse y comparen notas. Ten en cuenta cómo la dinámica grupal puede suprimir ciertas ideas de manera involuntaria y cómo los miembros del equipo menos asertivos podrían ser reacios a contribuir con sus valiosas ideas en el contexto del grupo.
Después de que hayas dividido el trabajo para el proyecto, escribe un cuadro formal y distribúyelo a todos los miembros.
Tabla que enumera las responsabilidades de los miembros del equipo de redacción para el proyecto
Programando el proyecto y equilibrando la carga de trabajo. Al principio de tu proyecto de escritura en equipo, establece un cronograma de fechas clave. Este cronograma te permitirá a ti y a los miembros de tu equipo hacer un progreso constante y organizado y completar el proyecto a tiempo. Como se muestra en el cronograma de ejemplo a continuación, incluye no solo las fechas de finalización de las fases clave del proyecto, sino también las fechas de las reuniones y el tema y propósito de esas reuniones. Observa estos detalles sobre ese cronograma:
- Varios encuentros están programados en los que los miembros discuten la información que están encontrando o no encontrando. (Un miembro del equipo puede tener información que otro miembro está buscando por todas partes.)
- Se han programado varias reuniones para revisar los detalles del proyecto, específicamente, el tema, la audiencia, el propósito, la situación y el esquema. A medida que aprendas más sobre el tema y te sientas más cómodo con el proyecto, tu equipo puede querer cambiar algunos de estos detalles o hacerlos más específicos.
- Se programan varios borradores. Los miembros del equipo revisan los borradores de las secciones individuales de los demás al menos dos veces, la segunda para ver si los cambios recomendados han funcionado. Una vez que se junta el borrador completo, este también se revisa dos veces.
Cronograma para un proyecto de escritura en equipo
Anticipando problemas y creando reglamentos del equipo. Piensa en cómo resolver problemas típicos que pueden surgir en un proyecto de equipo y documenta los acuerdos de tu equipo sobre estos asuntos en un documento de estatutos:
- Desequilibrio de carga de trabajo. Cuando trabajas en equipo, siempre existe la posibilidad de que uno de los miembros del equipo, por cualquier motivo, tenga más o menos que una parte justa de la carga de trabajo. Por lo tanto, es importante encontrar una manera de hacer un seguimiento de lo que cada miembro del equipo está haciendo. Una buena manera de hacerlo es hacer que los miembros individuales del equipo mantengan un diario o registro de qué tipo de trabajo realizan y cuánto tiempo dedican a ello.
Tanto durante como al final del proyecto, si hay algún problema, el diario debe dejar ese hecho muy claro y permitir un equilibrio más equitativo de la carga de trabajo. Al final del proyecto, los miembros del equipo pueden sumar sus horas dedicadas al proyecto; si alguien ha pasado un poco más de su parte de tiempo trabajando, los otros miembros pueden compensarlo invitándole a cenar o con alguna recompensa similar. De manera similar, a medida que te acercas al final del proyecto, si es evidente por los diarios que las responsabilidades laborales de un miembro del equipo resultaron, sin culpa de su parte, ser menores que las de los demás, él puede compensarlo haciendo más del trabajo de finalización, como escribir, corregir o copiar. - Miembros del equipo sin habilidades relevantes. Como puedes ver en la descripción de habilidades de los miembros del equipo mencionada arriba, un miembro no tiene habilidades relevantes para contribuir al proyecto. A veces, eso es solo un indicio de la ansiedad de esa persona o de la falta de interés en participar en un proyecto grupal. Por supuesto, cada miembro del equipo en un curso de escritura debería contribuir con una parte justa de la escritura para un proyecto. Sin embargo, hay muchas tareas que no requieren conocimientos técnicos, habilidades de formato o un ojo editorial agudo, por ejemplo: redactar y distribuir el plan del equipo, los estatutos, las actas de las reuniones del equipo; recordando a los miembros del equipo sobre las fechas de entrega y las reuniones programadas. De hecho, excepto por la ansiedad o la falta de interés, el miembro del equipo que se declara a sí mismo no calificado podría ser el mejor líder del equipo.
- Miembros del equipo que desaparecen. Si tu equipo tiene la mala suerte de contar con un miembro irresponsable que simplemente desaparece, ten un plan para qué hacer al respecto y documentalo en los estatutos de tu equipo. Una solución obvia es expulsar al miembro del equipo e informar al instructor si es un curso de escritura o al siguiente nivel de gestión si es una organización no académica.
- Desacuerdos entre miembros del equipo aparentemente arraigados. Es asombroso cuán vehementemente los miembros del equipo pueden estar en desacuerdo sobre aspectos de un proyecto de escritura en equipo. Tengan un plan, escrito en sus estatutos de equipo, sobre cómo resolver estos asuntos. ¿Deberían ser sometidos a votación? ¿Deberían "escalar" el asunto a una parte neutral o de nivel superior?
- Estilos de escritura y formato radicalmente inconsistentes. Debido a que las secciones individuales serán escritas por diferentes autores que probablemente tengan diferentes estilos de escritura, establezca una guía de estilo en la que los miembros de su equipo enumeren sus acuerdos sobre cómo deben manejarse las cosas en el documento en su conjunto. Estos acuerdos pueden variar desde lo general, como si debe haber una sección de antecedentes, hasta detalles específicos como cuándo usar cursivas o negritas y si es "clic" o "clic en." Vea el extracto de una hoja de estilo del proyecto a continuación. Para discutir estos temas, vea hojas de estilo y guías de estilo.
Antes de que tú y los miembros de tu equipo escriban los primeros borradores, no puedes esperar anticipar todas las posibles diferencias en estilo y formato. Por lo tanto, planea actualizar esta hoja de estilo cuando revises los borradores de las secciones individuales y, especialmente, cuando revises el borrador completo.
Extracto de una guía de estilo para un proyecto de escritura. Los elementos enumerados representan acuerdos que los escritores del equipo han hecho para darle a su documento la mayor consistencia posible.
Revisando borradores y terminando. Trata de programar tantas revisiones del trabajo escrito de tu equipo como sea posible. Puedes reunirte para discutir los borradores de cada sección individual, así como los borradores del documento completo. Cuando te reúnas, sigue las sugerencias para la edición entre pares que se discutieron en la sección anterior de este capítulo. Estrategias para la revisión por pares.
Una etapa crítica en la escritura colaborativa de un documento ocurre cuando unes en un solo borrador completo las secciones individuales escritas por diferentes miembros del equipo. Es en ese momento cuando probablemente notarás cuán diferentes son en tono, tratamiento y estilo cada sección. Como grupo, deben encontrar una manera de revisar y editar el borrador completo para que tenga una lectura consistente y no parezca tan claramente escrito por tres o cuatro personas diferentes.
Cuando hayas terminado de revisar y corregir, es hora del trabajo final para preparar el borrador para entregar. Ese trabajo es el mismo que si estuvieras escribiendo el documento por tu cuenta, solo que en este caso las cargas de trabajo se pueden dividir.
Información relacionada
Costo Real de Revisar Documentación en Word. clickhelp.com
Agradecería tus pensamientos, reacciones, críticas sobre este capítulo: tu respuesta—David McMurrey.
