Vou compartilhar contigo minha "metodologia". No caso minha metodologia é para artigos técnicos. E eu desenvolvi ela primeiro praticando, escrevendo artigos mesmo, na tentativa e erro. E só depois, analisando a estrutura que eu segui nos artigos, que eu formalizei nas anotações.

Nota: esse formato não funciona para todo tipo de artigo e pode e deve ser adaptado. Eu mesmo já modifiquei essas anotações várias vezes. :smile:

Isso é das minhas anotações pessoais no Notion (e sim, eu escrevo minhas anotações como se outra pessoa fosse ler):


Nessa metodologia vamos dividir o artigo em quatro partes sequenciais: IntroduçãoInícioMeioFim.

Introdução

É estressante ler artigos onde não são claros sobre do que se tratam logo no começo. Já vi artigos que enrolaram por vários parágrafos até finalmente chegar no ponto que importa.

A introdução deve deixar clara a proposta do artigo e o que o leitor espera obter dele de forma breve e concisa, em no máximo 2 parágrafos.

Início

No início do artigo deve-se explicar de forma simplificada o ponto principal do artigo. Dessa forma cria-se a sensação de progresso no leitor que irá sentir que está obtendo a informação que procurava.

O início não precisa (e nem deve) ser detalhista, para que a explicação seja a mais simples possível. Os detalhes devem ser explicados posteriormente.

Meio

No decorrer do artigo é onde se deve explicar os detalhes mais profundamente, assim esclarecendo a informação que foi passada no início.

Fim

Detalhes extras que não são essenciais para o artigo devem ser deixados para o final, assim não cansa o leitor com informação que ele não quer ler. Após o leitor obter a informação que queria talvez ele esteja mais suscetível a ler mais ou apenas pule o final. Isso dá ao leitor a possibilidade de pular informações extras sem o risco de perder informação essencial.

Dicas / Lembretes

  1. Desenhe: faça ilustrações para demonstração visual do que está sendo explicado.
  2. Não presuma conhecimento prévio: você não sabe o que o leitor já estudou antes. Na dúvida explique.
  3. Cite os termos técnicos em inglês e português: citar termo técnico somente em português pode ser ruim para a pessoa que posteriormente irá ler conteúdo em inglês.
  4. Código primeiro, explicação depois: pode ser um pouco confuso para o leitor acompanhar a "escrita" de um código de exemplo no artigo por falta de uma visão palpável de um resultado final. É mais claro apresentar o código de exemplo completo e, em seguida, explicar parte por parte. Se o exemplo de código for muito complexo uma boa ideia é dividi-lo em vários exemplos diferentes, onde cada exemplo aborda uma parte/conceito diferente. Mas cada exemplo ainda sendo um código completo, sem ser uma divisão em partes.
  5. Evite falar e não dizer nada: isto é, evite adicionar texto que não agrega em nada ao conteúdo. Quanto menos texto inútil no artigo, mais agradável será a leitura dele.
  6. Evite redundâncias: as vezes você pode passar a mesma informação duas vezes sem querer. Evite repetir a mesma coisa. Caso aconteça uma repetição, reformule o texto para que não seja necessário repetir.
  7. Artigos devem ser independentes: você não deve escrever um artigo presumindo que quem está lendo te conhece ou já leu algum artigo anterior. Você está escrevendo para o mundo todo, qualquer pessoa pode ler. Portanto cada artigo deve ter informações de forma independente, e caso exija uma leitura prévia (no caso de sequências, por exemplo) isso deve ser explicitado.