No que penso quando edito (2019)

 (evaparish.com)
2 pontos por GN⁺ 2024-04-07 | 1 comentários | Compartilhar no WhatsApp

Coisas em que penso ao editar textos

  • Transmita o texto com precisão

    • Antes de escrever, é preciso decidir o que você quer dizer.
    • Considere o tema, o público-alvo etc., deixe claro o objetivo do texto e registre isso no topo do documento.
    • Ao escrever e editar, compare sempre com esse objetivo para manter a consistência.

  • Repita dentro de limites razoáveis

    • Reafirme o tema no início e no fim do texto para que o leitor possa entendê-lo.
    • Para dar clareza, repetir usando substantivos em vez de verbos pode ajudar.

  • Simplifique

    • Remova palavras desnecessárias e torne as frases mais concisas.
    • Substitua expressões como "você" ou "você pode" por comandos mais diretos.
    • Divida frases longas em frases curtas e use vírgulas de forma adequada para ajudar a compreensão do leitor.

  • Elimine a voz passiva

    • A voz passiva torna o agente da ação ambíguo e deixa a frase menos clara.
    • Ao mudar para a voz ativa, a frase fica mais clara e mais fácil de entender.

  • Não use advérbios

    • Em vez de advérbios, use verbos mais específicos ou acrescente explicações.
    • Advérbios muitas vezes não transmitem o significado exato ao leitor e deixam ambiguidade.

  • Não presuma conhecimento prévio

    • Forneça explicações de contexto adequadas para informações que o leitor pode não conhecer.
    • Ao usar siglas pela primeira vez, escreva a forma completa e acrescente uma explicação.

  • Perceba o tom

    • O tom do texto deve ser consistente; não misture um tom amigável com um tom formal.

  • Evite jargão e clichês

    • Use expressões precisas para que o leitor entenda com facilidade.
    • Jargões podem ser difíceis de entender se o leitor não fizer parte de um grupo específico.

  • Use o espaço em branco

    • Divida parágrafos longos e use subtítulos, listas, tabelas etc. para melhorar a legibilidade.
    • Destaque o conteúdo importante em negrito para que o leitor não perca os pontos principais.

Conclusão

  • Os princípios básicos da edição de texto são transmitir o significado com clareza e remover palavras desnecessárias.
  • Seguindo esses princípios, você pode desenvolver seu próprio estilo e suas preferências.
  • O objetivo da edição é pensar sobre o uso da linguagem e fazer escolhas adequadas para transmitir a mensagem.

Opinião do GN⁺

  • Manter o objetivo e a consistência do texto durante o processo de edição é um princípio importante para qualquer tipo de escrita.
  • O uso da voz passiva é um estilo que deve ser evitado especialmente em documentação técnica, e a mudança para a voz ativa contribui para aumentar a clareza.
  • Evitar o uso de advérbios e usar expressões mais específicas é eficaz não só em documentação técnica, mas em qualquer tipo de escrita.
  • Explicações de contexto para informações que o leitor pode não conhecer são especialmente importantes em documentação técnica, pois aumentam a compreensão do leitor e melhoram a acessibilidade do documento.
  • Usar espaço em branco e separação visual é um elemento importante para melhorar a legibilidade de conteúdo online.

Leituras relacionadas

1 comentários

 
GN⁺ 2024-04-07
Opiniões do Hacker News

  • Resumo do primeiro comentário:

    • O autor diz que se sente honrado por seu texto ter gerado identificação em tantas pessoas.
    • Seguiu a curiosidade e se tornou engenheiro de software, mas depois de alguns anos de trabalho sentiu falta de uma função mais centrada na escrita.
    • Está procurando um papel que combine habilidades técnicas e capacidade de comunicação, e pode ser contatado pelo site e pelo LinkedIn.

  • Resumo do segundo comentário:

    • É incômodo usar siglas em documentação técnica sem apresentá-las antes.
    • Isso se repete em documentos de projeto e, quando a equipe muda, pode não restar ninguém que saiba o significado das siglas.
    • Às vezes, a única solução é tratar as siglas como nomes próprios e continuar usando-as.

  • Resumo do terceiro comentário:

    • Como revisor de documentação técnica, já usou muitas diretrizes.
    • Sugere adicionalmente não chamar a mesma coisa por nomes diferentes.
    • Quando há vários autores, a terminologia pode variar e confundir o leitor.

  • Resumo do quarto comentário:

    • Não concorda com o conselho de "evitar a voz passiva".
    • A voz passiva é uma ferramenta que pode mudar a perspectiva sobre a ação.
    • Ao usá-la, é possível escolher se a origem da ação será mencionada.

  • Resumo do quinto comentário:

    • É difícil decidir para quem se está escrevendo.
    • É preciso considerar leitores técnicos, leitores em geral e leitores não técnicos.
    • Há um conflito entre tentar tornar o texto acessível para mais leitores e a preocupação em reduzir o tamanho dele.

  • Resumo do sexto comentário:

    • Expressa entusiasmo por melhorar a escrita.
    • Dá conselhos sobre a importância de usar listas e como usá-las adequadamente.

  • Resumo do sétimo comentário:

    • Sugere evitar o uso da palavra "just".
    • "just" sugere simplicidade, mas na prática isso pode não ser verdade.

  • Resumo do oitavo comentário:

    • Enfatiza a importância do espaço em branco não só em documentação técnica, mas também em blogs, e-mails etc.
    • Parágrafos longos são difíceis de ler e as pessoas tendem a perder a atenção com facilidade.

  • Resumo do nono comentário:

    • No passado, ao trabalhar em um MSP, percebeu a importância de guias de produção bem escritos.
    • Com base na experiência adquirida em jornal, procura diretrizes que possam ajudar na redação de documentos.

  • Resumo do décimo comentário:

    • Sugere evitar o uso do tempo futuro.
    • Em documentação, é melhor escrever "se você fizer isso, isso acontece" em vez de "se você fizer isso, isso acontecerá".