Como você escreve blogs técnicos? [fechadas]

Eu costumo ler muito sobre coisas relacionadas à programação. Quando o tópico que leio não está diretamente relacionado ao meu trabalho (por exemplo, lendo sobre alguns algoritmos que não uso no trabalho cotidiano), esqueço-os.

Uma maneira de reforçar o que foi aprendido é escrever blogs. Eu sou iniciante em escrever blogs. Quando comecei a escrever, descobri que é muito difícil. Até simplesmente reproduzir o conteúdo leva cerca de duas horas. Escrever um bom pensamento sobre o blog geralmente leva um dia inteiro ou, às vezes, um fim de semana.

Isso é normal? Alguma dica para escrever tutoriais técnicos / blogs técnicos?

Escrever é difícil, boa escrita é ainda mais difícil. A questão de tentar explicar alguma coisa é que ela requer mais conhecimento do que apenas "meio que sabe disso". Acho que através dos blogs 1. descubro tópicos relacionados que preciso entender, 2. identifico onde meu entendimento é superficial

Leia estes slides http://www.ai.uga.edu/mc/WriteThinkLearn.pdf . Eles explicam muito sobre escrever (e até comparam com programação)

Todo trabalho de qualidade requer tempo e esforço. É de se esperar.

Alguns dos meus escritos mais antigos levaram cerca de três semanas para serem concluídos. Você escreve um rascunho, relê-o, faz as correções necessárias, digitaliza-o novamente e depois o lê. Leva tempo.

Uma idéia simples de como se manter motivado. Se você planeja algo grande, considere se faria sentido dividir o trabalho em duas ou três partes e publicá-las separadamente. Obviamente, as partes precisam ser úteis para os seus leitores. Então, como eles levam menos tempo, é mais provável que você realize e conclua o trabalho parcial.

Algumas dicas deste blogueiro técnico desconhecido:

• Verifique (não apenas leia) o código digitado recortando e colando da visualização para a linha de comando ou um arquivo de texto a ser executado. Várias coisas (como finais de linha, recuo e caracteres Unicode) podem ser confusas ao transferir de um editor (ou shell) para uma página da Web e vice-versa.
• Peça a um ser humano que verifique a ortografia, gramática e conteúdo - isso mostra que houve algum esforço para tornar os artigos corretos e fáceis de ler. Se não houver ninguém por perto, leia novamente o artigo inteiro antes de publicar.
• Se a plataforma de blogs possui destaque de sintaxe , use-o. Caso contrário, publique o código em algum lugar que o possua e vincule-o.
  • Corolário: mantenha grandes quantidades de código longe do texto do artigo. Isso é um pouco vago, mas se o texto está explicando como funciona algum código, é bom incluir um trecho. Se estiver apresentando um software para ser baixado, é melhor consultar uma interface da Web VCS.
• Cada artigo deve ser legível por si só . Fazer referência a outros artigos é bom, mas não presuma que o leitor tenha lido outras postagens antes desta.
• Use outros formatos além do texto quando eles ajudarem a compreensão. Para algumas coisas, o código é suficiente, mas para algumas, uma imagem ou mesmo animação pode ser muito mais compreensível.

Muitas vezes, acho que um post difícil leva tanto tempo porque requer pesquisa; essa pesquisa não apenas ajuda a sua postagem no blog, mas também ajuda a desenvolver seu próprio conhecimento pessoal no processo. Como você disse, você está reforçando o conhecimento escrevendo a postagem; você também está expandindo seu conhecimento. Abrace o tempo necessário e valorize-o como uma experiência de aprendizado.

Sim, é normal que a redação técnica do blog leve tempo. Para mim, a escrita leva o menor tempo possível (de apenas uma hora ou até um dia, dependendo da duração). Em seguida, a edição e a reescrita geralmente levam mais tempo (até dois ou até três dias). Outro aspecto mencionado que leva tempo é o esclarecimento de qualquer código de exemplo. Além disso, gosto de gastar tempo procurando links de suporte para meus tópicos. Tudo leva tempo!

Eu acho que você poderia escrever blogs técnicos agora, mas eu sugiro que você faça isso quando se tornar especialista em algum domínio específico. Passar um fim de semana não parece muito tempo. tudo depende da complexidade do tópico. Eu acho que o que estou dizendo é que o núcleo da sua ideia vem até você naturalmente. A execução pode (e vai) demorar mais.

As pessoas estão procurando conselhos de especialistas em um blog ... não experimentos noobs. mas estou falando de um modo geral. Não quero desencorajar você a escrever blogs. Mas lembre-se do seguinte.

1. Seu blog deve dizer algo novo. Não basta coletar dados e publicá-los em seu próprio blog

2. Tenha absoluta certeza do que você está dizendo, ou seja, mantenha-se com resultados empíricos fortes ou conceitos ou coisas altamente testados ou experimentados em primeira mão .

3. Esteja pronto para críticas.

4. Aprenda as técnicas de criação de blogs (precisão, concisão etc.)

5. Escreva algo porque você acha que deve ser escrito; não porque você acha que será lido.

Os elementos do estilo

Eu acho que a escrita técnica segue muitas das mesmas regras que qualquer escrita. Se você ler apenas um livro sobre como escrever, deve ser o clássico Strunks "Os Elementos do Estilo" . Ele percorre uma lista de coisas que melhorarão sua composição, sendo o principal (IMO), "Omita palavras desnecessárias".

Eu também recomendaria " On Writing ", de Stephen King . Embora seja mais sobre a escrita fictícia, ele ainda contém muitas jóias para qualquer escritor aspirante, especialmente em áreas como edição e processo de escrita.

Dito isto, a parte mais difícil da redação técnica não é a redação real, mas o esclarecimento de seus pensamentos sobre a redação. O pensamento confuso leva a uma escrita ruim. Uma boa redação exige que você tenha uma noção clara do assunto, e é por isso que ensinar e escrever é uma excelente maneira de dominar um assunto.

Bem, levo muito tempo para escrever posts, sim. Costumo escrevê-los por vários dias, ou mesmo deixá-los em rascunho por algumas semanas, ocasionalmente os lendo novamente e corrigindo e ajustando um pouco aqui e ali.

Leva tempo, mas se esse é o preço para escrever algo do qual não tenho vergonha depois, acho que vale a pena.