Usando o controle de versão do Git para redação

Eu acredito que os escritores modernos devem começar a pensar em seus processos ou fluxos de trabalho.

Em um mundo altamente distraído, é imperativo ter controle sobre a cadeia de tarefas que realizamos todos os dias como escritores. Tradicionalmente, os escritores colocariam sua escrita para as horas em que a distração é menor e o foco é alto. Infelizmente conselhos de Hemingway, Atwood etc., não são realmente aplicáveis a nós mais. O mundo em que vivemos é muito mais conectado e, portanto, têm muito mais armadilhas para escritores. Parte disso está sendo disciplinada o suficiente para não deixar a mídia social ou videos fofos de filhotes e gatinhos nos distrair no momento em que estamos escrevendo.

Mas desconexão da internet não é realmente uma opção se parte da sua redação requer verificações rápidas, grafias de palavras incomuns e técnicas, etc., - isso é muito verdadeiro para mim quando estou escrevendo. A outra questão é as distrações que estão dentro do próprio aplicativo de escrita; Como um usuário de longa data do Ms Word, achei que ele ficou mais bonito, mas mais lento e mais distraído. Eu falei sobre isso com mais detalhes como sendo entre as razões primárias para a transição para o Vim em primeiro lugar, então eu não vou falar extensivamente sobre isso. O ponto é que que escrever no mundo moderno, em dispositivos modernos pode estar longe de ser ideal.

Como eu já entrei em detalhes sobre o por que eu mudei para o Vim e controle de versão de código aberto, gostaria de usar este artigo para falar sobre como, especificamente usar a tecnologia de código aberto de controle versão, como git (e github).

O que é o controle de versão, novamente?

Fonte: https://git-scm.com/

O diagrama acima é uma ilustração de como realizamos o controle tradicional de versão. Este diagrama pressupõe que você tenha um dispositivo e que escreva apenas nesse dispositivo. No meu caso, escrevo em várias máquinas, incluindo meu telefone Android e uma seleção de laptops de idades variadas que uso para lugares específicos. A única tarefa comum que eu realizo entre todos esses dispositivos é escrita - é imperativo, portanto, que meus dispositivos capturem alterações e controle de versões de meus arquivos de maneira prática. Não mais file1V1_device1_date.doc como eu nomearia meus arquivos.

O diagrama acima também não leva em conta as ferramentas que usamos para escrever. Um processador de texto, como o LibreOffice Write, funciona em Linux, macOS e Windows, mas usar um processador de texto no telefone é uma experiência desagradável. Alguns de nós, escritores, também usamos outras ferramentas de texto, incluindo o Gmail ou nossos clientes de e-mail, para escrever pequenos esboços para a nossa escrita. Manter o controle de todos esses arquivos e e-mails em uma ordem lógica é cansativo - eu escrevi um livro usando tal processo e acredite em mim: o tempo que passei para descobrir nomes de arquivos, alterações de versão, comentários, notas e e-mails com notas adicionais, foi o suficiente para me levar à distração.

Alguns de vocês lendo isso podem afirmar corretamente que a tecnologia de backup baseada em nuvem existe. Enquanto os benefícios do armazenamento baseado em nuvem são imensos, e continuo usando-os, o controle de versão quase não existe, ou não é poderoso.

Um melhor fluxo de trabalho

Como o resto do planeta, o início da pandemia trouxe alguma ansiedade. Passei o tempo aprendendo desenvolvimento na web no Projeto Odin (altamente recomendado para aqueles que estão pensando em aprender HTML, CSS, JavaScript/Ruby).

Entre os primeiros módulos foi uma introdução ao Git: o que era o controle de versão e quais problemas procuravam abordar. Ler este capítulo foi uma revelação. Eu sabia imediatamente que este git era exatamente o que eu estava procurando como escritor.

A melhor maneira, então, não o controle de versão local, mas controle de versão distribuído. 'Distribuído' descreve a distribuição dos dispositivos de onde estarei acessando um arquivo e editando/mudando a partir de então. O diagrama abaixo é uma ilustração visual do controle de versão distribuído.

Fonte: https://git-scm.com/

O meu caminho

Meus objetivos na construção de um sistema de controle de versão para escrever foram os seguintes:

• Tornar meu repositório manuscrito acessível de qualquer lugar, de qualquer dispositivo
• Fácil de usar
• Reduzir ou remover a fricção que ocorre de trocar o contexto entre escrita, estudo e fluxos de trabalho de codificação - tanto quanto possível, usaremos a mesma ferramenta (isto é, Vim)
• Escalável
• De fácil manutenção

Com base nas necessidades acima, o diagrama abaixo é o meu sistema de controle de versão distribuído para a minha escrita.

Como você pode ver, meu sistema de controle de versão é uma adaptação simplista do controle de versão distribuída. Ao adicionar controle de versão do Git a uma pasta no armazenamento em nuvem (pCloud) no meu caso, posso agora desenhar os benefícios de ambas as tecnologias. Assim, meu fluxo de trabalho pode ser visualizado da seguinte forma:

Vantagens

1. Eu tenho uma ferramenta de escrita (e codificação)
2. Eu tenho controle de versão dos meus manuscritos, não importa qual dispositivo eu acesso o arquivo
3. É super fácil, dificilmente um inconveniente
4. Fácil de manter

Desvantagens

Os escritores entre vocês devem se perguntar quais desvantagens existem no sistema. Aqui estão alguns que antecipamos enquanto eu continuo usando e refinando este fluxo de trabalho.

• Comentários sobre rascunhos: Um dos recursos mais úteis dos processadores de texto é a capacidade de comentar. Muitas vezes deixo comentários para mim quando quero voltar a uma determinada parte do texto. Eu ainda não descobri uma solução para isso.
• Colaboração: os processadores de texto permitem a colaboração entre escritores. Durante meus dias de publicidade, usaria o Google Docs para escrever cópia e compartilhar o link com meus designers para extrair a cópia para anúncios e sites. No momento, minha solução alternativa para isso é escrever a cópia no markdown e exportar o arquivo de marcação para um arquivo .doc via Pandoc. Mais criticamente, quando meus manuscritos estão concluídos, eu precisaria ainda enviar os arquivos no formato .doc para meus editores. Uma vez que meu editor faz essas mudanças e envia de volta, faz pouco sentido para eu tentar abri-lo novamente no Vim. Neste ponto, as limitações do sistema se tornarão mais óbvias.

De forma alguma eu estou dizendo este é o melhor método, mas este é o melhor método para mim neste aponte na minha carreira. Eu imagino que vou estar refinando isso ainda mais ao passo que me familiarizo e fico mais confortável com a minhas novas ferramentas de código aberto para escrever e controle de versão.

Espero que isso seja uma boa introdução aos escritores que desejam usar o Git para o controle da versão de documentos. Isso não é de forma alguma um artigo extenso, mas compartilharei alguns links úteis para facilitar a viagem para você.

1.Git Basics from The Odin Project

2. Começando com Git
3. GitHub’s Basics of Git Tutorial

Última atualização deste artigo: 27 de june de 2021

PROPAGANDA