Escrevendo

Esta é uma série de artigos sobre o meu fluxo de trabalho para pesquisa e produção de textos. A primeira parte da série apresentou uma visão geral; as demais detalham ferramentas e funções do fluxo.

Criação do conteúdo

Chegou o momento de falar em escrita. Ao longo do seu trabalho, você vai escrever muito. Notas de trabalho, fichamento de referências, inúmeras versões do seu texto-alvo…

Reiterando algo que já mencionei na primeira parte desta série, um dos elementos essenciais do meu fluxo de trabalho é manter duas funções separadas: criação do conteúdo, por um lado, e formatação (ou apresentação) do conteúdo. A primeira função acontece ao longo de todo o trabalho; a segunda só acontece ao final.

Isso quer dizer que preocupações com fontes tipográficas, margens de páginas, textos destacados, e assim por diante, não são relevantes durante a criação do conteúdo. Um dos problemas do Microsoft Word é misturar as duas funções, fazendo o pesquisador perder tempo com detalhes de formatação durante a criação de conteúdo. Isso prejudica o fluxo de pensamento, e não traz qualquer benefício – especialmente porque, com grande frequência, as decisões de formatação precisarão ser modificadas na fase final do fluxo de trabalho.

É importante notar que deixar as decisões de formatação para o final do fluxo de trabalho não significa ignorá-las completamente, porque há elementos tipográficos que são relevantes durante a criação de conteúdo. Mas não em sua forma e sim em seu significado – o conteúdo semântico da formatação.

Semântica

Semântica é a parte da Linguística que trata do significado. Em um texto escrito, existem duas maneiras principais de transmitir significado. A primeira é a óbvia: o significado das palavras e frases que escrevo.

A segunda é mais sutil. Refiro-me ao significado de elementos tipográficos, de formatação do texto. Por exemplo, em textos acadêmicos, citações diretas de outros autores frequentemente aparecem com parágrafo recuado e com uma fonte tipográfica de tamanho menor que o usado no resto do texto; ou indicamos expressões de outras línguas em itálico.

Em documentos organizados em partes, o nível do título pode ser indicado numericamente, e / ou por características tipográficas – tipicamente, tamanho de fonte, ou negrito, ou linhas de destaque, e assim por diante.

O ponto importante, na fase de criação de conteúdo, é não se deixar distrair pela formatação. Por exemplo: não faz qualquer diferença, em termos de criação de conteúdo, se a citação de outro autor usa uma fonte tamanho 10 ou 12. Semanticamente, o que importa é saber que ali está uma citação de outro autor.

Da mesma forma, em termos de criação de conteúdo, é completamente irrelevante decidir se os títulos de seções têm negrito, e os títulos de subseções têm itálico, ou o contrário. Semanticamente, o que importa é indicar o nível do título; a formatação fica para depois.

Existem várias maneiras de escrever um documento de forma semântica. Em meu fluxo de trabalho, eu uso o markdown.

Markdown

Um documento markdown geralmente tem a extensão .md.

Importante: um arquivo markdown não deve ser editado no Microsoft Word ou em editores semelhantes (como o do LibreOffice). Use um editor básico, como o Bloco de Notas do Windows; no Linux, eu uso o ReText. Mas, como será visto em outras partes desta série, várias outras ferramentas usam o formato markdown.

O conteúdo de um arquivo markdown é texto comum. O que o distingue é o uso de caracteres especiais para indicar características semânticas. Por exemplo, a sequência de caracteres ‘**’ inicia e encerra um trecho em negrito, e o caractere ‘#’ indica níveis de títulos:

# Título geral

## Primeira seção

O texto é escrito normalmente, sem uso de entradas na primeira linha de um parágrafo.

Um parágrafo é separado de outro por uma linha em branco (use a tecla **Enter** duas vezes).

### Primeira subseção da primeira seção

### Segunda subseção da primeira seção

## Segunda seção

Uma das vantagens do formato markdown é que ele é entendido por várias das ferramentas deste meu fluxo de trabalho. Então, um mesmo texto pode ser editado em mais de uma ferramenta, sem perda de conteúdo.

O formato markdown tem muitos detalhes, e não vou explicar todos aqui; isso fugiria ao escopo desta série, que apresenta apenas os conceitos. Em todo caso, se você gostaria que eu fizesse um artigo detalhando o uso do formato, me mande um comentário.

Codificação do arquivo

Como eu mencionei acima, um documento markdown deve ser editado em um programa simples, como o Bloco de Notas do Windows. Mas isso não é tudo. Há ainda a questão da codificação usada no arquivo. É um detalhe bastante técnico, mas que pode ter um efeito considerável.

A codificação do arquivo significa como um caractere qualquer – como ‘a’, ‘6’, ‘§’, ou ‘Ç’ – é representado numericamente no arquivo. O problema é que diferentes ambientes de edição usam diferentes codificações.

Tipicamente, produtos da Microsoft usam uma codificação chamada Windows 1252, que é uma extensão não-padronizada de uma codificação chamada ISO-8859-1 – esta, sim, uma codificação padronizada. Mas as codificações mais usadas, hoje em dia, são as codificações UTF – no Brasil, UTF-8 é suficiente para quase todos os textos, mas uma codificação como UTF-16 pode ser necessária em alguns casos.

Qual a relevância disso? Se o seu trabalho acontece inteiramente em um mesmo ambiente – por exemplo, você usa dois ou três computadores, todos rodando Windows –, você dificilmente terá que se preocupar com isso.

O problema aparece quando você tem que usar arquivos criados em um ambiente em um ambiente diverso, ou compartilhar arquivos com outras pessoas. Em qualquer destes casos, você poderá abrir um arquivo e ler nele algo como ‘codificaϢδo’ ao invés de ‘codificação’.

Sempre que possível, use a codificação UTF-8. Vai facilitar muito a sua vida.

Partes publicadas

1. Fundamentos
2. Organização
3. Acervo
4. Escrevendo
5. Notas

Publicação anterior sobre o git: parte 1 e parte 2.