Dicas para escrever artigos técnicos

Dicas para escrever artigos técnicos

Olá Unicorns, venho escrevendo artigos há pelo menos 4 anos, e sempre sigo algumas regras pra ter uma escrita boa e um bom discernimento ao tema. Não estou dizendo que você deve seguir a risca tudo que tem aqui ou que essa é a melhor forma de escrever artigos, mas sim o que eu aplico nos meus nesses anos.

Vamos lá!

1º Passo: Introdução do tema

Escolher o tema e abordar uma breve introdução, seja ela uma experiência de trabalho ou estudos.

2º Passo: O que é?

É importante trazer para o(a) leitor(a) o que é aquilo que você está escrevendo, por exemplo:

O que é react?

React é uma biblioteca javascript criada para desenvolvimento de interfaces, ou seja, criar telas.

No exemplo acima podemos criar outros ganchos para assuntos no qual o(a) leitor(a) possa se interessar, sendo eles explicar o que é biblioteca ou até mesmo a diferença dela com frameworks que pode surgir comparações com Angular ou Vue, por exemplo.

O importante nesse ponto é não deixar o(a) leitor(a) com dúvidas que possam fazer com que saiam do seu artigo para pesquisar a palavra ou termo usado.

3º Passo: Porque usar?

Nesse ponto é importante a gente deixar bem claro o porque usar aquela determinada ferramenta ou método que você tá explicando. Assim você gera valor ao seu artigo, mostrando um propósito para ele e sempre lembrando dos ganchos que você pode ter pra trazer outros assuntos relacionados e agregar valor.

Por exemplo:

Podemos usar o React para criar componentes e reaproveitar eles de maneira simples fazendo com que uma alteração em um componente não gere impactos em outros componentes do seu projeto. Além disso podemos ter uma leve curva de aprendizado para escrever componentes e integrar outras bibliotecas de estilização.....

Olha os ganchos ai novamente, trazer o que são bibliotecas de estilização e componentes de uma forma bem resumida, pois o tema do artigo não é esse e não podemos perder o foco, mas também não podemos deixar dúvidas e perder o(a) leitor(a).

4º Passo: Como usar?

Mostre para o(a) leitor(a) como você pode usar aquilo, se for código traga exemplos, hoje em dia temos muitas ferramentas para trazer embedded dos trechos de código ou até mesmo criar uma aplicação hospedada, vou listar algumas aqui.

  • Carbon Now

    Cria prints de trechos de códigos;

  • Github Gist

    Cria embedded que podem ser copiados facilmente, além de deixar seu artigo bonitão e rico;

  • Codepen

    Cria projetinhos simples com HTML, CSS e JS com embedded

  • Codesandbox

    Capaz de criar projetos mais robustos em diversas linguagens, gerenciar bibliotecas e compartilhar repositórios

  • Repl.it

    Capaz de criar projetos mais robustos em diversas linguagens, gerenciar bibliotecas e compartilhar repositórios

Lembre-se de mostrar e explicar como usar cada coisa que você achou complexo de entender ou até mesmo que acha legal explicar.

5º Passo: Onde usar?

Traga para o(a) leitor(a) exemplos reais de onde pode ser usado ou aplicado o que está sendo proposto no tema do artigo, faça com que o(a) leitor(a) tenha interesse em aplicar aquilo de maneira simples sem muitos rodeios.

Por exemplo:

Podemos usar o React para criações de blogs estáticos ou até mesmo em grandes aplicações, o React hoje em dia é usado por grandes empresas como Facebook, instagram, iFood, B2W, etc...

Lembrando sempre dos ganchos que temos nos assuntos...

Por fim: Uma conclusão

É legal a gente ter uma conclusão do assunto desenvolvido com um breve resumo de tudo que abordou, em poucas palavras, mas nem sempre o assunto tem uma conclusão, mas tá tudo bem.

O importante é você se sentir bem e confortável escrevendo algo para outra pessoa, essas dicas são o que eu sigo e é algo que desenvolvi para que eu possa desenrolar o assunto, mas você pode aplicar outros métodos que não vai ser problema desde que se sinta a vontade e consiga transmitir aquilo que deseja.

Mais uma ultima dica é ler outros artigos com senso crítico tentando encontrar como você pode escrever algo tão legal quanto o que leu.

Espero que tenha gostado desse artigo e caso queira me procurar para revisão, dicas ou dar um "oi" pode me chamar nas redes que eu amo ajudar com esse tipo de assunto.

Beijos/Abraços do Uni 💜

Did you find this article valuable?

Support Diego Telles by becoming a sponsor. Any amount is appreciated!