Artigo original: Voice and Tone in the freeCodeCamp Community's Publication, escrito por freeCodeCamp.org

Traduzido e adaptado por: Daniel Rosa

Ao escrever um artigo para publicar no editorial da comunidade do freeCodeCamp, é importante saber como você está dizendo aquilo que você está dizendo.

Sobre o que estamos falando aqui? Estamos nos referindo à sua voz e ao seu tom. Esses dois aspectos da escrita podem ter um efeito grande na maneira como as pessoas reagem aos seus artigos, no quanto elas apreciarão a leitura e se elas lerão o artigo inteiro ou não.

Por isso, vamos falar um pouco mais sobre a voz e o tom para ajudar você a desenvolver essas duas questões para escrever tutoriais educacionais, encorajadores e interessantes para a comunidade de desenvolvedores.

Como desenvolver sua voz como escritor

Ao escrever, há várias coisas que se unem para criar a sua voz. O que queremos dizer, portanto, com "voz"? Bem, é a maneira como você soa ao escrever – a linguagem que você usa, como você estrutura suas frases, seu estilo de escrita e assim por diante.

Quanto mais você escreve, mais desenvolve um estilo mais forte e distinto. Pense em seus autores favoritos ou em algum autor que você possa ter estudado na escola. Por vezes, você pode sentir como se reconhecesse sua voz se pudesse ouvi-los falando. É isso que você desejará desenvolver como escritor para o editorial do freeCodeCamp.

Sua voz de escritor é algo que você não vai querer mudar. Assim que estabelecer a maneira como você escreve, tente se manter consistente e seguir escrevendo naquele estilo. Desse modo, os leitores saberão o que esperar ao lerem seus artigos e se sentirão à vontade com o modo como você escreve.

Aqui vai algo que você deve saber: as pessoas que leem seus artigos, com frequência, estarão, naquele momento, aprendendo a programar, aprendendo uma nova habilidade, procurando emprego ou tentando melhorar suas capacidades em um cargo que ocupam no momento.

Muitos desses leitores são adultos ocupados, que têm outros empregos, uma família e vidas fora do aprendizado da programação. Assim, você vai querer conversar com eles e dar a eles as boas-vindas em seu artigo, fazendo com que se sintam à vontade e interessados.

Aqui vai mais uma dica importante sobre a voz: Em geral, é melhor escrever um artigo em voz ativa do que em voz passiva. Isso dá uma sensação de responsabilidade pela ação àquele que a realiza, sendo uma maneira mais forte de escrever.

Por isso, ao invés de escrever algo como "Agora, o projeto pode ser publicado", diga algo como "Agora, publique o projeto". Isso mantém o foco no leitor e torna claro que eles são as pessoas que devem realizar a ação.

Se quiser ler alguns dos artigos dos autores que desenvolveram vozes muito potentes, confira os artigos de Colby e os artigos de Estefania. Esses são apenas dois exemplos – muitos dos autores do freeCodeCamp encontraram suas vozes de modo bastante claro. Você pode ver também os artigos do próprio Quincy, fundador do freeCodeCamp, pois ele tem uma das vozes de escritor mais reconhecíveis de todas (todos os textos dos artigos mencionados acima estão em inglês).

Um exemplo de voz ativa x voz passiva

Vejamos outro exemplo de como utilizar a voz ativa em sua escrita. Aqui temos um parágrafo que utiliza muito a voz passiva. Perceba como soa isso para você ao ler em voz alta:

Para desenvolvedores da web iniciantes, o HTML, o CSS e o JavaScript devem ser estudados. Quando os cursos são feitos, os artigos são lidos e os projetos são criados, os assuntos são aprendidos em profundidade. É especialmente importante criar coisas com as habilidades que você está aprendendo, pois isso permite que o conhecimento seja consolidado em sua mente.

Em vez de escrever algo como o que vemos acima (que, logicamente, foi um pouco longe demais com a voz passiva para fins de exemplo), experimente ler em voz alta o texto abaixo:

Se você é um desenvolvedor da web iniciante, aprenda o HTML, o CSS e o JavaScript. Depois de fazer alguns cursos, ler uns artigos e criar alguns projetos, você vai aprender sobre esses assuntos profundamente. É especialmente importante criar coisas com as habilidades que você está aprendendo, pois isso ajuda a consolidar o conhecimento em sua mente.

Por que o segundo texto é melhor? Bem, para começar, ele faz uso de verbos de ação e coloca o leitor no centro (ele é, em geral, o sujeito). A linguagem também é mais poderosa e direta, fluindo naturalmente sem parecer arrogante ou estranha.

Como considerar o tom na hora de escrever

O tom é um pouco diferente da voz, pois pode mudar, dependendo daquilo que você escreve, qual o público-alvo e quais as sensações que você está tentando descrever.

Se estiver tentando vender um produto, por exemplo, seu tom deverá parecer mais o de uma autoridade, ao mesmo tempo em que esperançosa e, talvez, um pouco intrigante – pois você quer que as pessoas confiem no que você está vendendo e queiram comprar o produto.

Se estiver contando a história de um sucesso pessoal, seu tom deverá soar mais alegre, comemorativo, expansivo e confiante – sem ser autoelogioso ou arrogante. No fim, você quer dar ao leitor aquela sensação de sucesso e, ao mesmo tempo, encorajar as outras pessoas e inspirá-los.

Se estiver contando a história de como conseguiu seu primeiro emprego em tecnologia, seu tom deverá ser empolgado e encorajador. Se estiver explicando como usar uma sintaxe específica em Python, seu tom deve ser prático, informativo e engajador.

Isso não significa que você não possa usar tons diferentes no mesmo artigo. Mesmo que você esteja escrevendo um guia técnico de grande profundidade, ainda é possível trazer ao texto um pouco de leveza e humor para manter o engajamento dos leitores.

Um exemplo de como usar os diferentes tons em sua escrita

Vamos examinar um exemplo com apenas alguns parágrafos breves que mostrem os diferentes tons.

Primeiro, vamos imaginar que estamos criando um tutorial de React e que você queira ter o tom de uma autoridade, que conheça do assunto e que seja encorajador. Você pode escrever algo assim:

Neste tutorial, ensinarei a você o básico sobre o React para que você possa usá-lo com confiança em seus projetos. Você aprenderá tudo sobre states, hooks, componentes e outros conceitos básicos do React. Ao final deste artigo, você poderá criar sua própria aplicação em React com os recursos x, y e z.

Está bem direto ao ponto, mas também fornece informações claras, informa o leitor o que ele conseguirá e vai direto ao assunto.

E que tal uma história inspiradora e pessoal – como deve ser o tom, nesse caso? Bem, você provavelmente vai querer um tom mais semelhante ao de uma conversa, abordando o leitor de modo engajador. Por que seu leitor se importaria em ler uma história? Você quer que eles consigam se relacionar com aquilo que você está dizendo e que sintam uma conexão. Algo assim:

Quando eu me formei na faculdade, sabia que eu queria fazer uma pós em arqueologia. E foi o que eu fiz – as coisas, no entanto, não saíram como eu planejei. A vida deu voltas, eu encontrei o freeCodeCamp, comecei a me voluntariar como revisora do editorial da comunidade e acabei sendo contratada para trabalhar lá em tempo integral. Vou contar aqui como isso aconteceu.

Espero que esse início tenha deixado você curioso e chame sua atenção de modo que você siga lendo.

Como escolher o tom certo para o editorial do freeCodeCamp

Ao escrever para o editorial da comunidade do freeCodeCamp, seu tom deve permanecer positivo, encorajador e de auxílio. Evite soar depreciativo ou negativo, pois esse tipo de escrita não cabe no editorial.

Aqui temos umas dicas para ajudar você a desenvolver um tom de ajuda e positivo em seus artigos.

Escreva como se estivesse falando com amigos

Ao explicar um conceito técnico, faça de conta que está conversando com um amigo. Imagine como você o explicaria para um amigo seu ou para um colega de trabalho. Tome nota do que você imaginou e depois saia escrevendo. Embora possa precisar ser um pouco editado para ajustá-lo, o texto que você imaginou já pode ser um bom começo.

Você provavelmente não gritaria com um amigo para repreendê-lo nem pensaria em fazer esse amigo se sentir mal por não saber algo. Você pensaria em quebrar um conceito em partes compreensíveis, de modo que seu amigo conseguisse aprender e reter o aprendizado. Então, você explicaria e descreveria o conceito em uma linguagem simples, a mesma que você usa em suas conversas diárias.

Se você abordar seus artigos de modo semelhante, isso ajudará você a escrever de modo casual, simples e tranquilo. O editorial não é uma revista acadêmica. Você não precisa ser excessivamente formal em sua escrita. Torne-o amigável e acessível quando puder.

Embora o melhor seja manter uma linguagem simples e direta, também é útil manter um nível mínimo de profissionalismo e educação. Afinal, você quer que as pessoas levem seus artigos a sério e que os reconheçam como sendo recursos úteis e esclarecedores. Assim sendo, evite usar gírias em excesso, assim como expressões muito informais (use o mínimo de "kkkk", "vc" ou "kd" possível) e assim por diante.

Mesmo assim, não sinta receio de usar do humor quando ele for apropriado – todos gostam de dar uma risada aqui e ali. Quando você está lendo um tutorial extenso e técnico, por vezes, faz bem à mente uma parada estratégica para dar uma risada. Nada de forçar a barra, mas se a fala engraçada vier naturalmente para você, deixe-a fluir.

Qual seria, então, a aparência dessa linguagem? Bem, em grande parte, como a linguagem usada neste artigo. Sempre que um membro da equipe do freeCodeCamp escreve um artigo para o editorial da nossa comunidade, tentamos manter um tom semelhante – geralmente casual, positivo, útil e com o "conhecimento de causa".

Use "você" em vez de "nós"

Ao escrever um tutorial passo a passo, é fácil querer envolver você mesmo na orientação. Você pode querer dizer algo como "Primeiro, precisamos instalar o VS Code, pois o usaremos como nosso editor de código." O "você", porém, é uma palavra poderosa, sendo mais eficaz usar o "você" do que o "nós".

Pense que está dando instruções diretas ao seu leitor – "Primeiro, você precisa instalar o VS Code, pois você o usará como seu editor de código." Isso torna a instrução mais direta, forçando o leitor a se concentrar naquilo que está fazendo. Afinal, você espera que ele, o leitor, esteja acompanhando e programando junto com você durante o seu tutorial.

Você pode usar o "nós", naturalmente, se for adequado para o contexto – apenas não o utilize em excesso, em especial em guias de passo a passo.

Um ponto relacionado a esse é não usar "alguém" excessivamente como sujeito da referência (como "Para fazer isso, alguém precisaria do código a seguir..."). É formal demais e soa arrogante, o que pode deixar as pessoas um pouco desanimadas de prosseguir com a leitura. Em vez disso, sempre prefira usar o "você" (ou, em casos mais raros, o "nós", como discutimos acima).

Qual seria a aparência disso em um exemplo maior? Compare:

Certo. Hoje, falaremos sobre a criação de um clone do Twitter. Examinaremos todos os passos de que precisamos para criar a aplicação e, no final, teremos uma aplicação de redes sociais em pleno funcionamento. Não entraremos em detalhes x ou y, pois eles estão um pouco fora de nosso escopo. Aprenderemos, no entanto, tudo o que precisamos saber para concluir esse projeto.

com:

Hoje, ensinarei você a criar um clone do Twitter. Você verá todos os passos que precisa conhecer para criar a aplicação. No final, você terá uma aplicação de redes sociais em pleno funcionamento. Não entraremos em detalhes x ou y, pois eles estão um pouco fora do escopo deste tutorial. Você aprenderá, porém, tudo o que precisa saber para concluir esse projeto.

Você consegue perceber que a ênfase do segundo parágrafo é no leitor - "Você fará isso" ou "Você aprenderá" e assim por diante. Isso faz com que o leitor pense em si, no que podem fazer, no que estão aprendendo e no que eles estão obtendo ao ler o tutorial.

Está implícito que você guiará o leitor durante todo o caminho – assim, não é necessário que você se inclua usando o "nós" a menos que seja uma frase mais geral sobre as circunstâncias ou algo assim (veja um exemplo disso acima, no segundo texto, quando dissemos "Não entraremos em detalhes x ou y...").

Mantenha o tom positivo e relativamente apropriado para todos os públicos

O freeCodeCamp é uma comunidade amigável, receptiva e inclusiva. Os recursos gratuitos que fornecemos estão abertos a todos e em qualquer lugar. Queremos garantir que nossos artigos, tutoriais e vídeos estejam acessíveis a todos.

Por causa disso, queremos que os artigos que publicamos estejam livres de linguagem negativa, impeditiva de alcançar o que buscamos e excessivamente sarcástica, bem como de comentários ofensivos ou feitos para ferir. Os artigos que publicamos no editorial devem ser educacionais, inspiradores, úteis e encorajadores – o seu tom deve refletir isso.

Ninguém deve se sentir menos inteligente ou envergonhado ao ler seus artigos. Eles devem se sentir inspirados, curiosos e estarem prontos para ir mais longe.

Mesmo que seu leitor seja um total iniciante e que esteja com muita coisa para lidar e pensar a respeito ao mesmo tempo, seu tom e a linguagem que você usa não deve desencorajar nem acabar afastando o leitor. Ajude-o a saber o que esperar escrevendo uma introdução clara ao assunto, apresentando todos os prerrequisitos ou exigências que você precisa ter com ele (o leitor) antes de ele começar o tutorial e assim por diante.

Por fim, é desnecessário dizer que não há lugar para o discurso do ódio, racismo, ataques ou menosprezo aos outros, xingamentos ou bullying virtual na comunidade do freeCodeCamp. Mantenha isso tudo longe de seus artigos ao escrever.

Vejamos aqui um exemplo do que NÃO escrever:

Se quiser entender Redux, você precisa ser esperto. Afinal de contas, é um assunto difícil, especialmente para aquelas pessoas que não têm um diploma de Ciência da Computação. Desenvolvedores mais antigos também podem não entender o Redux, pois eles simplesmente já não são mentalmente rápidos o suficiente para isso.

Obviamente, você precisará ler tutoriais, fazer cursos e criar um projeto com ele para aprender sobre ele como um todo – isso é o mínimo. Simplesmente, não seja idiota e não pule o básico.

Pois bem – NÃO escreva assim! Espero que esteja claro para você o motivo pelo qual escrever assim soa excessivamente negativo, indulgente, impeditivo de realizar o que queremos e, simplesmente, ofensivo como um todo.

Lembre-se – mantenha-se positivo, encorajador, claro e educacional!

Obrigado pela leitura e boa escrita para você!

Quer saber mais sobre como criar grandes artigos? O editorial da comunidade do freeCodeCamp tem um guia de estilo com muitas dicas de como escrever e as diretrizes do editorial.