Guia intergalático do artigo técnico

This content originally appeared on DEV Community and was authored by Letícia Silva

Tudo o que você precisa saber para fazer o seu primeiro texto sair do papel!

ㅤ

Uma das premissas mais verdadeiras na vida para mim é aquela que diz que "Todo mundo tem algo a aprender e a ensinar". E é baseado nisso que eu sempre incentivei as pessoas a compartilharem seus conhecimentos, seja através de palestras, tutoriais, artigos, posts ou vídeos. Independente da forma, quando você decide compartilhar algo que já sabe, está passando por um processo nada trivial e muito importante, onde precisa explicar um conteúdo que já aprendeu para uma pessoa que possa (ou não) ter conhecimento no assunto. E sendo sincera, a segunda opção é bem mais comum e difícil de se colocar em prática. Por isso mesmo, decidi vir aqui compartilhar um pouco da minha experiência sobre a tarefa - NADA fácil - de escrever artigos técnicos acessíveis.

Mas Lelê, por que "acessível"?

ㅤ

Meme com mulher perguntando "por que?"

ㅤ

E eu te explico: materiais técnicos, como artigos, possuem uma fama de serem "difíceis de entender". E óbvio que essa constatação não é 100% verdadeira, mas ela se torna real a partir do momento em que houve apenas uma preocupação na criação do material em questão: a sua existência. Uma propriedade muito importante e lembrada com pouca frequência é a tal de legibilidade, que torna as coisas mais fáceis de se ler, ou entendíveis. E há muitas maneiras de colocar essa engrenagem para girar, mas a principal é: ter empatia com quem está lendo. Você pode não saber quem é ou não ter conhecimento do background da pessoa leitora, mas deve ter como parâmetro que a sua avó (ou qualquer outra pessoa que não tenha muito conhecimento no assunto) consiga compreender o que está escrito.

Partindo desse ponto, vamos para um dos tópicos que eu mais amo no mundo: analogias!

A arte de explicar utilizando exemplos simples

ㅤ

Mulher jogando papéis picados para alto

ㅤ

Quando penso em analogia, sempre me vem a cabeça atividades comuns do dia a dia: andar, escovar os dentes, cozinhar, fazer compras, assistir série. Esse termo faz referência a um processo que passa a ser explicado de uma maneira descomplicada, e normalmente utiliza coisas que façam parte da realidade da maioria das pessoas. Por exemplo, minha avó não entende o que é um algoritmo, mas sabe o que é uma receita de bolo. Então, se eu disser para ela que um algoritmo funciona como uma série de passos, assim como uma receita de bolo, provavelmente ela entenderá o conceito (mesmo sem saber programação) e conseguirá construir uma ponte entre os dois assuntos.

Mas vamos a outro exemplo. Imagine que você está tentando explicar a alguém sobre o conceito de Github, mas não consegue encontrar um conceito do dia a dia para utilizar na explicação. E eis que você pensa numa geladeira! O Github é um site que funciona como uma "rede social das pessoas programadoras", onde se armazena código e projetos em repositórios. Uma geladeira é um local cheio de prateleiras e compartimentos, onde se guardam alimentos e pratos prontos. Então, se pensarmos no Github como uma geladeira que não guarda comida, mas principalmente código, e possui divisões de acordo com o tipo / categoria / área em que o código está sendo utilizado, as coisas ficam muito mais legíveis e visuais.

"Uma imagem vale mais que mil palavras", ou quase isso

ㅤ

Gif com as obras do pintor Van Gogh

ㅤ

Que um exemplo pode ficar bem mais explícito como uma imagem não se discute. Mas, no momento em que se deseja ilustrar algo com uma figura, deve pensar-se também em alguns outros pontos, como:

• Na resolução dessa imagem

Não é porque "no meu computador funciona" que no computador de outras pessoas vai funcionar, não é mesmo? O que você consegue visualizar bem no seu monitor de 29' full HD pode não ser o ideal para quem está lendo do celular. Por esse motivo, sempre prefira figuras com alta resolução ou envie seu artigo para outras pessoas verificarem se as fotografias não estão distorcidas.

• Nas cores dessa imagem

O que funciona para um pode não funcionar para os outros. Você pode conseguir identificar todas as cores presentes em uma imagem, mas há pessoas que não e tá tudo bem. Lembre-se sempre disso quando for descrever a imagem, pois citar uma determinada parte da figura através de sua cor pode não ser acessível.

• Se a figura contém texto, e se ele está legível

Sempre tome o cuidado de descrever as imagens, para que pessoas cegas, com baixa visão ou com alguma dificuldade na vista não sejam prejudicadas por não conseguirem visualizar a foto em questão.

• Na explicação dessa imagem

Imagens devem ser usadas quando necessárias, mas isso não significa soltar elas aleatoriamente ao longo do texto. Sempre tente manter a coerência entre o que está escrito e ilustrado.

• Nos direitos autorais da figura

Imagens, se não criadas pela própria pessoa autora do texto, foram retiradas de algum lugar. É super importante passar dentro do artigo de onde a figura foi extraída, e tentar ao máximo utilizar imagens que possuam licença de direitos autorais livre. Nesses sites você pode encontrar figuras nessa categoria:

Foque na comunicação, não no tecniquês

ㅤ

Homem se comunicando enquanto faz gestos com as mãos

ㅤ

• "Mas eu entendo o que eu escrevo"

Bem, bom pra você né, anjo. Utilizar muitos termos técnicos, além de dificultar a leitura do conteúdo que você dedicou seu tempo e preprou com carinho, faz com que uma gama de pessoas não sintam-se capazes de consumir o seu conteúdo por ele ser difícíl de interpretar. Nas minhas aulas de Storytelling, sempre enfatizava esse fato para a turma, pois é crucial para que as pessoas sintam-se confortáveis o suficiente com o enredo que você montou e se identifiquem com a história.

Lembre-se: não usar o tecniquês não significa escrever algo ruim, mas sim fazer com que mais pessoas entendam o conteúdo que você está publicando e ajudar o conhecimento a ser disseminado.

• Entenda quem você quer atingir

Não adianta produzir um artigo com conteúdo extremamente avançados, se o seu desejo é alcançar as pessoas que possuem mais senioridade, e vice versa. Se você quer ter um público mais geral e menos específico, pense em estratégias e conteúdos que possam ajudar nisso, e que atinjam essas pessoas.

C-O-M-U-N-I-Q-U-E

ㅤ

Meme do Bob Esponja apresentando a comunicação

ㅤ

Hoje em dia muito se fala sobre comunicação neutra e afins. Você sabe realmente o que isso significa e sua importância?

• Pessoas são pessoas, e apenas isso

Esse termo surgiu com o intuito de fazer com que TODAS as pessoas, independente de gênero ou opção sexual, sintam-se representadas. Isso significa que, referir-se a alguém como "desenvolvedor", "o programador", "o cara", é algo excludente e que deve ficar no passado. Além de ignorar a existência de mulheres em uma determinada área ou assunto (isso é muito comum em tecnologia, principalmente em vagas), você pode acabar excluindo pessoas não binárias ou que se identifiquem com um pronome que você não esteja utilizando.

• O temido "x"

Eu já vi muita gente criticando e muita gente usando termos terminados com "x" no final, como "desenvolvedorxs", "cientistx", "alunxs", etc. Acontece que, esse x que as pessoas cismam em colocar para deixar as coisas "inclusivas" acaba tornando o processo mais doloroso para pessoas deficientes visuais que precisam utilizar leitores de tela. Isso porque leitores de tela não conseguem reproduzir o som representado por esses termos, exatamente por esse x não estar configurado nos equipamentos. Por esse motivo, NÃO UTILIZE X nos termos para tentar ser uma pessoa inclusiva. O efeito rebote é real.

• Tira o "x", mas coloca o "e"

Como solução para não usar o x, as pessoas começaram a colocar o e no final, como forma de tornar acessível e diverso o texto escrito. Acontece que, de acordo com as normas da língua portuguesa, isso é uma prática errada. Eu não estou aqui para defender um lado ou outro, mas para dizer que: há uma saída que não exclua absolutamente ninguém - seja por exclusão de minorias, seja por ilegibilidade - e que torna a leitura mais fluida, acessível e inclusiva.

• O inclusivo - e mais esquecido - substantivo

Composto, primitivo, derivado, próprio: calma, isso não é aula de português, mas também é importante! Um dos tipos de substantivos menos citados e mais importante é o coletivo, que engloba um grupo de itens do mesmo tipo, e é extremamente útil para se referir a um grupo de pessoas, sem necessariamente utilizar um pronome que defina gênero. Grupo, comunidade, pessoas, turma, estudantes são ótimos exemplos para fazer isso.

Seja confiante!

ㅤ

Personagem da série Lucifer emanando confiança

ㅤ

Quando perguntei no Twitter quais as maiores dúvidas da galera a respeito de artigo técnico, recebi diversas respostas, e vou tentar respondê-las agora:

• Será que vai ser útil pra alguém?

• Será que vai ser realmente útil?

Eu tenho uma tese (vulgo mantra) de que todo mundo há algo para compartilhar e algo para aprender. Isso serve para eu que estou escrevendo desse lado, para você que está lendo do outro, para a pessoa idosa que está caminhando na rua e para a criança brincando de futebol no andar de cima. Independente de quem seja, as pessoas têm muito a agregar. E por isso mesmo isso não deveria ser uma pergunta, mas uma AFIRMAÇÃO de que sim, o seu conteúdo tem muita utilidade para alguém.

• Será que o que vou dizer está certo?

Olha, eu não conheço alguém que saiba de absolutamente tudo. Mesmo quem seja visto como uma referência de uma determinada área, essa pessoa pode não saber tudo dela. E tá tudon bem! Precisamos normalizar que as pessoas, ainda mais as desenvolvedoras, não precisam ser gênias das tecnologias que trabalham para poder falar sobre elas :)

• Será que alguém consegue explicar melhor que eu?

Talvez. Não posso te afirmar nem negar, exatamente pelo fato do mundo ter quase 8 bilhões de pessoas. Mas isso não significa que, só porque há a possibilidade de alguém explicar melhor, você não deva se permitir explicar sobre um tópico.

Vou te dar um exemplo pessoal: eu tenho uma palestra, que fiz lá em 2018, e dou ela até hoje. Seu nome é "Data Science: É de comer?", e eu já palestrei em eventos nacionais, internacionais e locais usando ela, dezenas de vezes. Ela inspirou artigos, palestras e podcasts, e muita gente fala bem quando levo ela para os eventos. Mesmo te contando tudo isso, não significa que seja a melhor palestra do mundo. A única certeza que ela me traz é: toda vez que vou ministrá-la em algum lugar, eu aprendo mais sobre o assunto. E consigo aprimorar minhas falas, slides e ganchos, simplesmente porque estou praticando isso. Então, antes de se comparar com alguém ou considerar que uma determinada pessoa consegue explicar melhor que você, faça! Apenas faça e se aprimore nisso, porque essa é a única maneira de voce ganhar experiência: praticando.

• Como se limitar a pesquisa para não se perder em tantas possibilidade?

Definindo seus objetivos e metas a serem atingidas com um determinado conteúdo. Quando você decide falar a respeito de um assunto, deve pensar no que pretende focar e como deseja abordar o tópico em questão, pois esses pilares te nortearão no desenvolvimento da sua pesquisa, e fará com que você estabeleça os principais pontos que deseja destacar.

• De que forma devo escrever? O mais formal possível? Menos formal?

Depende muito de que está escrevendo. Eu, por exemplo, não uso uma linguagem extremamente formal, porque gosto que as pessoas se identifiquem com o que estou abordando. Isso também não significa que eu use apenas termos que estão hypados (famosos) na área, apenas porque eles ganharam visibilidade no momento, ou não respeite as normas do português. Escrita pra mim, independente do gênero ou objetivo, é uma forma de se expressar. E gosto que as pessoas e enxerguem no que eu produzo.

• Será que não estou passando alguma informação errada ou não tão certa?

Olha, eu sempre pesquiso muito antes de passar uma determinada informação, e recomendo que as pessoas também façam isso. Porém, há dois fatos bem interessantes sobre esse ponto, que são: não precisamos saber tudo, e errar é humano. Engana-se quem pensa que artigos técnicos são carregados de informações 100% verídicas na maior parte do tempo, porque não são. Já encontrei diversas vezes erros e afirmações gritantes que, claramente, mostravam que não havia sido feito uma pesquisa ou a pessoa que produziu tinha embasamento. Por isso mesmo, a recomendação é: pesquise, e se não souber, pergunte. Não custa nada, inclusive.

• Me embasar em artigos de diferentes pessoas sobre o assunto ou buscar afunilar mais minha base de busca?

Eu adoro me embasar em artigos de diferentes pessoas, e também amo fazer pesquisas para tornar a definição do que pretendo escrever mais clara. Uma coisa não impede a outra, mas acho que há alguns pontos importantes nisso:

-> Se embasar é diferente de fazer cópia. Diversas vezes, artigos e conteúdos de outras pessoas me deram ideias, mas plágio é crime e sou totalmente contra a isso;

-> Sempre que citar a fala / pesquisa / conteúdo de alguém, dê os créditos e de preferência, coloque o link para o material;

-> Quando for pesquisar para afunilar mais a sua base de buscqa, tome cuidado para não acabar se encantando com outras temáticas e esquecendo a sua original. Não há problema algum em escrever sobre tópicos relacionados, mas deixar o assunto que você queria tratar porque encontrou outro pode gerar frustração (já aconteceu comigo). Nesse caso, recomendo optar por escrever dois textos, cada um tratando de uma temática específica, ou caso deseje, englobando um assunto no outro. Reflita se faz sentido.

• Quais os passos para produzir desde o início até sua publicação?

Bem, há muitas formas de se fazer isso, incluindo rascunhar em um papel qual é a estrutura que você quer obter e as metas a serem atingidas com o seu artigo, mas acredito que um esqueleto sempre pode ajudar!

Pensando nisso, decidi montar um esqueleto baseado no que faço, e deixei disponível para você baixar e modificar como quiser! O template está bem simples, e você pode encontrá-lo aqui.

Caso haja interesse, posso organizar uma live ou workshop para que possamos construir juntos!

Gif de um boneco mandando corações

ㅤ

Você também pode conferir mais artigos meus e como organizo as ideias nos meus perfis do Dev.to, Medium e The Relicans.

Se quiser trocar uma ideia, me dá um alô no Twitter que a gente conversa!

Beijinhos científicos,

Lelê <3

This content originally appeared on DEV Community and was authored by Letícia Silva