Is it possible to write collaboratively in Quarto documents?
Only if you change your writing process.
🇪🇸 Este post está escrito en inglés y español. Puedes encontrar el texto en español más abajo.
🇺🇸 This post is especially dedicated to all of you social science PhD advisors and senior lab researchers. You probably have students or younger colleagues who’d like to use Quarto and R Markdown documents to communicate findings. Yet they rarely seem to succeed.
Do you want to help them succeed? Please read my recommendations below.
Many times, I’ve heard people saying they struggle using Quarto or R Markdown docs to write papers or internal reports. “My advisor can’t give me feedback here; there isn’t a track changes feature.” I’ve shared the same thought for the longest time! It almost feels like collaborative writing can only be done on Google Docs.
Over the last 2 years, however, I’ve changed my mind. You can write and edit together with your students using Quarto or R Markdown, as long as you change your collaborative writing process. You can’t use the same process you use when you write in Google Docs.
Tips to change your collaborative writing process
Discuss the different writing phases in detail. You may think that you and your students are speaking the same language, but you probably aren’t. What you think is obvious is probably news to your students. So, discuss who does what when and how in detail first. At the very least, define your expectations for an outline, a first draft, and a final draft.
Encourage your student to include a few figures or tables in the outline. This will help them to think hard about how to communicate findings from the start. It will also help you think how to support your student to use simple language to describe results and their importance.
Be a partner. If your student is the first author of the paper or report, your main job is NOT to be their copyeditor. Your main job is to be their thought partner. Especially in the beginning of the writing process, they need your help challenging assumptions and bringing the perspective of the reader.
Use feedback templates. You may think that adding 487 suggested changes in a Google Doc is great feedback, but it probably leads to more confusion than clarity. Providing feedback is different from copyediting. The feedback your students need (especially as they build towards a full draft) should be around how ideas connect together. Once you agree on how to present ideas, then you can move to copyediting. Structure the feedback template using guiding questions or key elements that you’d like to see on an outline, first draft, or full draft.
Simulate a peer review. Don’t edit with track changes; send them a separate doc with comments that they need to respond to. If your feedback is focused on paragraph structure, then they will have to address that comment and tell you how they changed things. If your comment is focused on ideas, then they will have to debate or argue in their response, which will clarify their thinking process or make it more transparent.
🇪🇸 Este post está especialmente dedicado a todos los profesores de doctorado en ciencias sociales y a los investigadores senior de laboratorio. Probablemente tengan estudiantes o colegas más jóvenes que deseen utilizar los documentos de Quarto y R Markdown para comunicar sus hallazgos. Sin embargo, nunca parecen lograrlo completamente.
¿Quieres ayudarlos a tener éxito? Por favor, lee mis recomendaciones a continuación.
Muchas veces, he escuchado a gente decir que tienen dificultades para usar los documentos de R Markdown para escribir documentos o informes internos. "Mi profesor no puede darme feedback aquí; no hay una función de seguimiento de cambios". ¡He compartido el mismo pensamiento durante mucho tiempo! Casi parece que la redacción colaborativa solo se puede hacer en Google Docs.
Sin embargo, en los últimos 2 años, he cambiado de opinión. Puedes escribir y editar juntos con tus estudiantes usando Quarto o R Markdown, siempre y cuando cambies tu proceso de escritura colaborativa. No puedes usar el mismo proceso que utilizas cuando escribes en Google Docs.
Consejos para cambiar tu proceso de escritura colaborativa
Discute las diferentes fases de la escritura en detalle. Puede que pienses que tú y tus estudiantes están hablando el mismo idioma, pero probablemente no lo estén. Lo que tú crees que es obvio, probablemente sea una novedad para tus estudiantes. Por lo tanto, discute quién hace qué, cuándo y cómo en detalle primero. Como mínimo, define tus expectativas para un esquema, un primer borrador y un borrador final.
Anima a tu estudiante a incluir algunas figuras o tablas en el esquema. Esto les ayudará a pensar detenidamente sobre cómo comunicar los hallazgos desde el principio. También te ayudará a pensar cómo apoyar a tu estudiante para que use un lenguaje sencillo para describir los resultados y su importancia.
Sé un compañero. Si tu estudiante es el primer autor del documento o informe, tu principal tarea NO es ser su corrector de pruebas. Tu principal tarea es ser su compañero de pensamiento. Especialmente al principio del proceso de escritura, necesitan tu ayuda para cuestionar suposiciones y aportar la perspectiva del lector.
Usa plantillas de feedback. Puedes pensar que añadir 487 cambios sugeridos en un Google Doc es un gran feedback, pero probablemente lleva a más confusión que claridad. Proporcionar feedback es diferente de hacer correcciones de estilo. El feedback que tus estudiantes necesitan (especialmente mientras elaboran un borrador completo) debe girar en torno a cómo se conectan las ideas. Una vez que estés de acuerdo en cómo presentar las ideas, puedes pasar a la corrección de estilo. Estructura la plantilla de feedback utilizando preguntas guía o elementos clave que te gustaría ver en un esquema, primer borrador o borrador completo.
Simula una revisión por pares. No edites con seguimiento de cambios; envíales un documento separado con comentarios a los que necesitan responder. Si tu feedback se centra en la estructura del párrafo, entonces tendrán que abordar ese comentario y decirte cómo han cambiado las cosas. Si tu comentario se centra en las ideas, entonces tendrán que debatir o argumentar en su respuesta, lo que aclarará su proceso de pensamiento o lo hará más transparente.