Executando verificação de segurança...
9

Como escrever um artigo?

Eu sinceramente, não sei escrever um artigo. Gostaria de ajuda, para aprender a criar algo minimamente legível, de fácil acessibilidade, para que qualquer pessoa possa aprender. Mesmo sendo uma tarefa um pouco difícil, já que depende do tipo de conteúdo que está sendo apresentado. Irei fazer algumas perguntas, que eu mesmo irei responder com base em artigos que já li no passado, e peço que você responda ou até mesmo crie novas perguntas com a sua resposta.
Obs: Já peço de antemão desculpas, por qualquer erro de ortografia, que pode ocasionar em um mal entendimento do texto. Já que não costumo escrever muitos textos.

  1. Quais tipos de conteúdo devo colocar como um artigo? Um tutorial pode ser um artigo?

  2. O conteúdo depende do tipo da plataforma?

  3. Devo indicar, escrever ou colocar no artigo, um conteúdo anterior ao atual?

    • Exemplo: Indicar/escrever/colocar um conteúdo de fundamentos da matemática, para ensinar cálculo, álgebra lineal, geometría analítica…
  4. Como devo estruturar um artigo? Começo, meio e fim?

  5. Devo escrever o artigo com uma ortografia 100% correta? Ou, está tudo bem que seja só compreensível?

  6. Devo colocar imagens/gifs no artigo?

  7. Existe tamanho ideal, indicado ou máximo de um artigo?

  8. Qual didática é recomendado usar em um artigo?

  9. Devo escrever um artigo com um conteúdo/conhecimento que eu domino?

  10. Devo escrever um artigo com um conteúdo que pode envelhecer mal?

Essas são as perguntas que eu acho mais relevantes no momento, para talvez, escrever um bom artigo. Algumas respostas são relativamente curtas.

0 - Quais tipos de conteúdo devo colocar como um artigo? Um tutorial pode ser um artigo?

Muitas vezes encontro artigos com conteúdos dos mais diversos tipos de conhecimento. Por esse motivo, eu poderia supor que, qualquer tipo de conteúdo que ensinando alguma coisa, poderia ser um artigo, até mesmo tutoriais ensinando uma tecnologia nova, ou até mesmo uma receita culinária… Talvez a única diferença de um texto que é um artigo para outro que não é, seria a maneira de se comunicar com o público e o ponto de vista do leitor.

1 - O conteúdo depende do tipo da plataforma?

Daria para resumir em um simples “sim”, porém existem algumas plataformas que são generais, no sentido de poder colocar qualquer tipo de conhecimento. Vamos pegar por exemplo essa plataforma “tabnews”, na publicação Tentando construir um pedaço de internet mais massa, resumindo muito, daria para dizer que é focado para quem trabalha na área da Tecnologia, mas, não dá para generalizar e dizer que é de programadores (desenvolvedores de software em geral), pelo que eu posso ver é tão extenso, que vai da “agronomia até engenharia espacial“. Acho que por ter sido feito pela Turma, e divulgado por eles, talvez tenha sido visto como algo para quem trabalha em específico com TI, desenvolvimento web… Sabemos que o tópico “Tecnologia” é muito extenso, ou seja, daria para criar artigos incríveis, sem ser sobre TI, e ainda seria Tecnologia, como código binário e como componentes elétricos funcionam, para pessoas mais "técnica", sem ter a necessidade de um artigo focado na divulgação científica, ou para pessoas mais leigas sobre tecnologia. Por que não criar artigos destrinchando conhecimentos complexos, como física de partículas? (eu ainda quero estudar sobre isso algum dia :) A resposta é simples, só depende de alguém criar e publicar aqui…

2 - Devo indicar, escrever ou colocar no artigo, um conteúdo anterior ao atual?

Pegando um gancho na resposta da pergunta número 1, sobre “física de partículas”,
como que alguém vai entender sobre o assunto se, mal saber matemática básica?
Por esse motivo, deve-se indicar livros, "documentos” ou artigos , sobre o que é necessário, para ler o artigo atual, deduzir que a pessoa já sabe sobre o que você está falando, isso retira a possibilidade de ter um novo leitor, ou contribuidor. Por que eu vou ler, se nem ao menos sei para que serve ou de onde vem? Como eu disse anteriormente “Tecnologia” é uma área muito vasta.

3 - Como devo estruturar um artigo? Começo, meio e fim?

Daria para resumir a criação de um artigo em :

  • Resumo: Resumir o assunto previamente para situar o leitor sobre o assunto em questão, ou direcionar o leitor, a algum artigo com algum outro conhecimento, que será necessário para continuar lendo.
  • Começo, meio e fim: Por ter vários tipos de conhecimentos diferentes, e se tratar de um artigo que pode se tratar de algo que pode ter conteúdo prático, como por exemplo, exercícios de algoritmos, se esse for o assunto, até onde eu saiba, não existe exercícios em uma redação… E por esse motivo irei categorizar “começo, meio e fim”, como um processo completo, para ensinar ou falar sobre um determinado assunto, que pode ou não ter um conhecimento prévio, ou até mesmo levar para um próximo artigo…

Ou seja, se precisa de um conhecimento prévio, daria para dizer que não começa aqui, e por fim acaba levando para um "próximo artigo” ele não termina aqui.

4 - Devo escrever o artigo com uma ortografia 100% correta? Ou, está tudo bem que seja só compreensível?

Sinceramente, acho que não precisa ser 100% correto em questão de ortografia escrita, desde que o leitor compreenda o que está escrito, já está ótimo. Só não se esqueça, que existem gírias e termos distintos para algumas regiões do Brasil, ou até mesmo países que falam portugues, por esse motivo use o bom senso. Por esse motivo eu tento escrever o mais correto possível, e por não saber me comunicar verbalmente com outras pessoas.

5 - Devo colocar imagens/gifs no artigo?

Essa pergunta é um grande “depende”, se for para a melhor compreensão do leitor, ótimo, se não, é melhor só não colocar… Isso serve para pequenos trechos de código também.

6 - Existe tamanho ideal, indicado ou máximo de um artigo?

Dá para levar no bom senso, se ele precisar ser completo por si mesmo, é melhor ser extenso e cansativo, sendo completo, em vez de ser incompleto. Se poder separar em artigos diferentes, e continuar coeso, ótimo, separe em partes para o leitor não ficar exausto.

7 - Qual didática é recomendado usar em um artigo?

Eu sinceramente, não sei responder essa pergunta, já que cada indivíduo aprende de maneiras diferentes. Mas acho que um bom começo seria ensinar do mesmo jeito que você aprendeu, se funciona para você, pode funcionar para outras pessoas.

8 - Devo escrever um artigo com um conteúdo/conhecimento que eu domino?

Eu creio que você deve escrever artigos, principalmente quando não se domina o assunto, para fixar e validar o conhecimento, e adquirir mais experiência com outras pessoas.

9 - Devo escrever um artigo com um conteúdo que pode envelhecer mal?

Sim, como alguém vai conhecer um determinado assunto se ninguém fala dele. Como por exemplo, criar um artigo sobre o Next.js 13, quando for lançado o 15 ou o 16, poderá ser tão diferente que, será perca de tempo ler sobre a versão 13, mas até esse dia chegar, é melhor fazer um artigo com a versão atual.

Considerações finais

Como eu disse inicialmente, não sei escrever artigos, tutoriais ou qualquer coisa do gênero. É tudo isso que consigo lembrar sobre o assunto, e peço que ajude a contribuir, se possível. Se você sabe fazer artigos, escreva todo o possível.
Já agradeço, por todos que leram ou contribuíram.

Carregando publicação patrocinada...
4

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. 😄

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.
2

Coloca a mão na massa e vai aprendendo e aperfeiçoando com o tempo, não tem muito segredo!

Só não tenta começar de forma perfeita, só vai te frustrar!

1

Também estou nessa tara de começar a entender como artigos são feitos, pra mim, eles são bem flexíveis, não há muito o que é certo ou errado, principalmente aqui no TabNews com essa comunidade maravilinda.
Eu já consegui escrever um artigo sobre o freeCodeCamp aqui, e ao menos pra mim me pareceu bastante claro tudo o que escrevi, e o seu também!
Que tal se fizéssemos uma troca, tá afim de dar uma olhada no meu artigo e avaliá-lo?