Escrevendo Sobre Programação de Computadores

Escrever sobre programação e informática é desafiador. Esses temas são complexos e é difícil criar uma narrativa compreensível e interessante.

Além disso, o português é um idioma exigente. Tenho a tendência de escrever como falo, o que resulta em textos difíceis de ler.

Para facilitar, criei algumas regras que servem como guia. Elas não são rígidas, apenas orientações sem uma ordem específica.

• Seja direto ao ponto. Evite floreios desnecessários e vá direto ao assunto.

• Evite anglicismos desnecessários. Use termos em português sempre que possível. Por exemplo, adotamos alguns anglicismos como “mouse” e “kernel”. Aqui estão algumas substituições úteis.

• Evite jargões técnicos. Se necessário, explique-os ou inclua um link para uma definição.

• Inclua exemplos. Demonstrar um conceito com um trecho de código ajuda a esclarecer ideias. Por exemplo, ao explicar a função sort.Slice em Go (Go 1.23 ou posterior):

  package main
  
  import (
      "fmt"
      "sort"
  )
  
  func main() {
      // Exemplo simples de ordenação de inteiros
      numbers := []int{42, 7, 19, 3, 15}
      sort.Slice(numbers, func(i, j int) bool {
          return numbers[i] < numbers[j]
      })
      fmt.Println(numbers) // Saída esperada: [3 7 15 19 42]
  }
  

• Inclua referências e links. Cite fontes confiáveis, como a documentação oficial do Go ou o guia “Effective Go”, para apoiar seus argumentos e orientar o leitor.

• Ilustre com imagens. Use diagramas, capturas de tela de interfaces ou fluxos lógicos. Uma imagem simples de um diagrama de arquitetura de software pode tornar o texto mais acessível.

• Use listas, negrito e outros elementos para destacar informações importantes. Isso ajuda a quebrar o texto e facilita a leitura.

• Mantenha parágrafos curtos. Parágrafos com no máximo 3 linhas evitam o cansaço do leitor.

• Revise e edite. Leia o texto em voz alta se você soar estranho é porque o texto esta ruim.

Eu normalmente escrevo para mim mesmo. A melhor forma de aprender alguma cosia é tentar explicar para alguém, então escrever sobre informática e tentar explicar o que estou fazendo serve tanto como anotações para o futuro, exercício de escrita e estudo.

Cesar Gimenes