Ao longo da carreira docente, em particular na função de orientação de estudantes, mais especificamente ainda na revisão de textos (relatórios, monografias, artigos, etc.) produzidos por eles, há muito indico o LaTeX como linguagem de marcação para escrita de textos acadêmicos/científicos (veja aqui ou aqui alguns dos motivos pra isso).

Para o controle de alteração e comentários na revisão destes textos, vinha usando o Git, sistema de controle de versões muito usado para software, inicialmente num repositório em servidor local e, posteriormente, me rendendo a uma plataforma Git na nuvem (BitBucket). Mais recentemente, me rendi ao Overleaf, um editor LaTeX colaborativo na Web, cuja versão paga permite controle de alterações mais amigável, particularmente para não-devs.

Ainda assim, para um processo de escrita colaborativo, em especial na revisão de textos escritos por orientados, é interessante estabelecer um protocolo de revisão, de modo a não ter retrabalho (ex.: ter que reler uma seção que já foi revisada, mas teve alterações apenas em poucos trechos) e o processo ser mais eficiente. Esse post descreve o protocolo que uso com meus orientados.

Como as funções necessárias para este protocolo requerem a versão paga do Overleaf, em primeiro lugar o projeto deve ser criado por alguém com conta paga no Overleaf (por exemplo, eu) e compartilhado com os demais coautores. Em seguida inicia-se o processo de Escrita, Revisão e Edição, seguido por ciclos de Revisão-Edição. Na sequência, descrevemos o processo mais simples de trabalho entre Estudante e Orientador. No caso de haver outros coautores o processo deve ser adaptado:

Escrita inicial (estudante)

A primeira versão do texto o estudante escreve normalmente (ou seja, em modo edição no Overleaf). Quando achar que tem algo que já pode ser enviado para revisão do orientador, deve avisá-lo.

Aqui, o texto escrito a ser revisado pode ser um documento inteiro, um capítulo, uma seção, de acordo com a organização do estudante. Lembrando que sempre que um texto é enviado para revisão, deve-se aguardar a revisão para voltar a mexer naquele texto. Enquanto isso, pode-se adiantar outras partes do documento. Recomenda-se, portanto, dividir a revisão nos capítulos/seções do documento.

Revisão (orientador)

Assim que possível, o orientador faz sua revisão (lembrando que há sempre uma fila de textos para revisão a ser observada). A revisão no Overleaf será feita no modo Reviewing, que é habilitado clicando num botão com o ícone de um lápis que fica abaixo da barra de formatação, no topo do editor e trocando de Editing para Reviewing, como mostra a Figura 1.

Neste modo, a edição realizada no documento ficará explícita de duas formas:

(a) Ao marcar um texto e adicionar um comentário, o texto fica marcado de laranja e o comentário aparece numa barra Review ao lado do editor, como ilustra a Figura 2. Como pode ser visto, os comentários possuem um botão de checkmark (✅). Este botão serve para resolver um comentário, o que faz o comentário “sumir” (retornaremos a este assunto abaixo).

(b) Ao editar diretamente o texto em modo revisão, novos textos aparecem marcados de verde e a mudança é também destacada ao lado do editor, junto dos comentários, como pode ser visto na Figura 3. Diferentemente dos comentários, no entanto, as mudanças apresentam dois botões: o checkmark (✅), que serve para aceitar uma mudança e um X (❌) que serve para rejeitar a mudança.

Edição (estudante)

Assim que o orientador avisar ao estudante que fez a revisão, o estudante abre novamente o texto revisado no Overleaf e a primeira coisa que deve fazer é mudar para o modo Reviewing como feito anteriormente pelo orientador (vide Figura 1), para que o orientador possa posteriormente ver o que o estudante mudou no texto que ele já revisou. Isso é MUITO importante, pois do contrário o orientador talvez precise ler todo o texto novamente, mesmo em caso de mudanças pontuais, fazendo com que o processo fique mais ineficiente e demorado do que o necessário.

Em seguida, o estudante deve:

1. Passar pelas modificações feitas na revisão e ver se concorda com elas. Caso concorde, deve clicar no checkmark (✅) para aceitar. Caso discorde, NÃO deve rejeitá-las, mas adicionar um comentário explicando porque discorda. Para adicionar um comentário, marque um trecho de texto e clique no botão Add comment que aparece acima do texto marcado.
2. Passar pelos comentários feitos pelo orientador, fazer as alterações solicitadas e responder o comentário explicando o que foi feito para atendê-lo. NÃO resolva comentários, eles serão resolvidos pelo orientador.
3. Avisar o orientador quando a edição for concluida e o texto pode seguir para nova revisão.

Ciclos de Revisão-Edição

A partir daqui, os procedimentos de Revisão pelo orientador e Edição pelo estudante se repetem em quantos ciclos forem necessários até o texto ser concluído.

Em novos procedimentos de Revisão, o orientador resolve os comentários que já foram atendidos de forma satisfatória e adiciona tréplicas nos que ele não considerar resolvidos pra que sejam reconsiderados pelo estudante no próximo ciclo de Edição. Modificações feitas pelo estudante também serão aceitas ou comentadas, conforme o caso.