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.

Escrever é uma habilidade importante para um desenvolvedor.

É como você informa suas ideias, influencia as pessoas, defende suas capacidades e aumentos de salário, além de produzir comentários e documentação para ajudar as outras pessoas.

“O que muitos subestimam é que ser um bom escritor,
seja de e-mails ou de documentos, permite que você cause um impacto maior. Percebo que muitos engenheiros ignoram essa habilidade.

Você pode ter orgulho de seu código. Também pode ter orgulho do trabalho que é escrever… Escrever é uma habilidade extremamente subestimada pelos engenheiros.” –Urs Hölzle (Primeiro vice-presidente de engenharia do Google)

Saber escrever permite:

• Impressionar futuros empregadores
• Ajudar s solidificar o que você aprendeu há pouco
• Compartilhar percepções com outros desenvolvedores
• Evitar o sofrimento de horas de pesquisa para outras pessoas

O freeCodeCamp também pode, de fato, ajudar a desenvolver suas habilidades de escrita. Ele pode ajudar você com ideias baseadas naquilo que as pessoas estão procurando, além de revisar e editar sua escrita para garantir que tudo está bem explicado. Depois, você recebe o auxílio de ter seu artigo publicado para um público vasto e diversificado.

Tudo isso é feito pela equipe do editorial, que é bastante amigável e, o que é mais importante, muito útil. Ao escrever mais artigos, você aprenderá mais sobre quem são os membros da equipe e sobre como eles podem ajudar você.

Explicarei aqui brevemente como eu comecei a escrever para o freeCodeCamp e minha experiência com ele até o momento. Também falaremos sobre o guia de estilo das publicações do freeCodeCamp, que você pode encontrar aqui.

Quem escreve para o freeCodeCamp?

Autores de todos os tipos escrevem para o freeCodeCamp.

Alguns são professores profissionais que têm cursos de programação, outros são desenvolvedores independentes. Alguns ainda estão aprendendo programação, enquanto outros são engenheiros de software que trabalham em tempo integral... e por aí vai.

Há pessoas de diferentes lugares do mundo e que falam línguas maternas diversas – são muitas as vozes representadas no freeCodeCamp.

Não existe, portanto, um pré-requisito fixo para alguém se tornar um colaborador do editorial do freeCodeCamp. Não há uma verificação do fato de você ter feito ou não uma faculdade de Ciência da Computação (de fato, muitos programadores autodidatas escrevem artigos para o editorial). Ninguém testa você ou espera que você tenha terminado todo o currículo antes de escrever.

Você só precisa ter alguma experiência anterior escrevendo para poder fornecer amostras de seu trabalho ao se inscrever para se tornar um colaborador.

Há, contudo, algumas diretrizes sobre o conteúdo com o qual você pode contribuir (por exemplo, o freeCodeCamp não é o lugar para apresentar sua famosa receita de lasanha).

Eu sou um engenheiro de software que trabalha em tempo integral. Escrevo para aprender mais sobre tópicos que acho interessantes.

O freeCodeCamp distribui seus artigos de modo tão amplo que, só no mês de janeiro de 2021, as pessoas passaram 600 horas lendo os artigos que escrevi. Isso é bom demais.

Do que trata o guia de estilo do freeCodeCamp?

O guia de estilo é a forma como o freeCodeCamp padroniza suas expectativas e diretrizes, de modo que todos os colaboradores saibam como pesquisar, escrever e apresentar melhor seus artigos. Ele também ajuda a garantir que o material publicado é de alta qualidade.

O guia de estilo trata de tópicos como tamanho, dicas de composição, como escrever um bom título, como escolher uma imagem de capa, como não plagiar o trabalho alheio, dicas de como evitar as publicações cruzadas e muito mais.

Também achei útil fazer o curso de escrita técnica do Google, que você pode encontrar aqui. Se não quiser fazer o curso, você pode ler meu resumo sobre ele aqui (em inglês), já que talvez você não tenha à disposição as 4 horas para fazer todo o curso.

Esse curso me ajudou a aprender algumas dicas úteis comuns sobre a escrita técnica, mas ele não é obrigatório para o freeCodeCamp.

Como se inscrever para ser um autor no freeCodeCamp?

Se quiser se tornar um colaborador do editorial do freeCodeCamp, primeiro leia o guia de estilo. Nele, você encontrará o formulário de inscrição.

Ao preencher a inscrição, é solicitado que você faça um link para 3 artigos que você escreveu no passado.

Se não tiver três amostras, ou se o trabalho que você fez é privado, faça uma conta em dev.to ou no Hashnode e escreva alguns artigos. Isso ajuda a equipe editorial do freeCodeCamp a aprender sobre seu estilo de escrita, sobre o que você gosta de escrever e se você se encaixaria bem nas publicações.

Permita-me apenas salientar que você deve ler o guia de estilo do freeCodeCamp. Leia-o duas ou três vezes e envie um e-mail para a equipe se não tiver 100% de certeza sobre algo que é dito nele.

Se você escrever os tais 3 artigos seguindo as diretrizes de estilo do freeCodeCamp, suas chances de ser aprovado como um colaborador serão ainda maiores.

Mas eles também "aprovam apenas uma pequena parcela" dos que se inscrevem para colaboradores. Desse modo, não se sinta desencorajado se não tiver sucesso da primeira vez.

Meu conselho para que você seja aprovado é tentar encontrar o que falta entre os artigos que você está lendo de momento. Você vai escrever artigos para quem está começando do zero ou para leitores intermediários? Qual será o seu nível de detalhamento? Você tem uma linguagem de programação preferida? Com que frequência você faz uso de humor? Nenhuma ou usa várias referências engraçadas? Como os leitores aplicarão esse conhecimento?

Quando eu comecei a escrever, eu não entendia bem o gênero dos textos e errei algumas vezes (usei de escrita satírica em um artigo e outras ideias de artigo que eu usei não eram lá grandes coisas). Porém, depois de alguma prática e de conversar com a equipe, comecei a melhorar e a entender qual era o gênero de textos dos artigos do freeCodeCamp.

Mas eu não escrevo bem

E daí? A melhor maneira de melhorar na escrita é... escrevendo! Se você acha que suas habilidades como escritor não são das melhores, busque dar a você mesmo uma meta – por exemplo, escrever 50 palavras por semana relacionadas a qualquer tópico. Algo que você acha que consegue alcançar e em um tópico que você gostaria de escrever a respeito é ótimo.

Dedique-se por uns 6 meses para ver se está progredindo. Pense sobre o que você não gosta a respeito de sua maneira de escrever e tente tratar disso.

O outro conselho que eu posso dar para melhorar sua escrita é ler mais. Quanto mais eu li, melhor ficou minha escrita com o passar do tempo e vendo como outras pessoas faziam isso.

Eu não sei sobre qual assunto escrever!

Escreva sobre algo que você quer aprender. Você não precisa ser um especialista em algo para escrever a respeito. Você desenvolve a especialização pela escrita, discussão e pesquisa de tópicos pelos quais você é apaixonado.

Você também pode perguntar à equipe editorial se quiser alguma ajuda depois de obter sua conta de colaborador.

E se eu estiver errado?

Terá a revisão da equipe, então, ao menos, você não errará sozinho. Outras pessoas analisarão seu texto e você poderá editá-lo após a publicação caso tenha entendido algo errado em sua pesquisa.

É uma boa forma de aprender, também. Quando você publica algo e está errado, as pessoas mandarão mensagens diretas para você para corrigi-lo. Eu já recebi mensagens sobre coisas que as pessoas achavam que não estavam claras. Agradeci a elas, revisei o que foi dito e isso geralmente me ajudou a melhorar meus artigos.

Não sinta medo de tentar e errar!

Eu escrevo muito lentamente

O freeCodeCamp não tem um cronograma em mente para você. Eles não enviam e-mails forçando você a escrever um artigo por semana.

Escreva o que e quando quiser. A equipe editorial estará lá para revisar o texto e ajudar você da maneira que eles puderem quando você estiver pronto. Se você publicar apenas um artigo no ano, tudo bem!

Inglês não é a minha língua materna

Também não é a língua materna de muitos colaboradores do editorial do freeCodeCamp. Eles estão praticando o inglês escrevendo e contribuindo com o público do freeCodeCamp.

Espero que isso tenha feito você se encorajar em vez de se sentir intimidado a forçar os limites de sua zona de conforto se você sempre quis experimentar a escrita técnica.

Conclusão

Você pode se inscrever aqui para colaborar com o editorial do freeCodeCamp.

Parte do que escrevi foi influenciado pela fala de Quincy que você encontra aqui (em inglês) a respeito de escrever artigos técnicos. Encorajo você a assistir a apresentação caso planeje se inscrever para colaborar com o freeCodeCamp no futuro. El também oferece estudos de caso fascinantes sobre pessoas que começam a escrever e alguns benefícios que tiveram com isso.

Eu gostei muito de escrever para o freeCodeCamp e foi, para mim, uma experiência incrivelmente positiva. Aconselho a todos a tentarem escrever, também.

Mesmo que você acabe não fazendo isso no freeCodeCamp, é uma habilidade para a qual vale a pena investir um tempo e ajudará você a se tornar um desenvolvedor ainda melhor.

O autor compartilha seus escritos no Twitter (em inglês) caso você tenha gostado desse artigo e queira ver mais.

Nossa publicação ajudará você a ensinar e a inspirar desenvolvedores, designers e cientistas de dados do mundo todo.

Por sermos um dos sites de tecnologia da web mais visitados, o freeCodeCamp.org pode ajudar você a alcançar milhares de pessoas que se beneficiarão com seu conhecimento.

Nossa organização sem fins lucrativos também tem uma grande presença nas mídias sociais, grande acessibilidade, SEO e uma reputação estabelecida como um recurso de aprendizagem sério. Tudo isso resultará em mais leitores para seus artigos.

Neste guia de estilo, daremos a você dicas de como maximizar seu impacto criando artigos poderosos.

Este não é o lugar para desafios ao estilo “um texto por dia no blog” ou de publicações de observações baseadas em fluxo de consciência.

Traga fatos. Traga citações. Traga trechos de código. Traga visualizações de dados.

Anos observando os dados mostraram que quanto mais detalhado for um artigo, por mais tempo as pessoas o lerão e maior a probabilidade de compartilharem o artigo com seus amigos.

Se você não conseguir escrever pelo menos 1.000 palavras sobre o seu tópico, é interessante pesquisar um pouco mais a respeito dele.

Aprofundando e expandindo sua pesquisa, você poderá oportunizar mais percepções aos seus leitores.

As pessoas têm o que fazer. Capture a atenção delas imediatamente. Como fazer isso? Com um título que chame a atenção.

Títulos: aquela parte do seu artigo que 100% das pessoas vão ler

Antes de começar a escrever sua história, dedique um tempo a compor um título que chame a atenção. Todo o seu artigo fluirá a partir desse título e se apoiará nele em busca de suporte.

Encontramos dois arquétipos que funcionam bem: artigos técnicos com profundidade e narrativas pessoais.

Aqui, vemos algumas estruturas de títulos que descobrimos funcionar bem para artigos técnicos com profundidade:

• "Como consertar…"
• "Como criar…"
• "Como [fazer uma tarefa] com [ferramenta]"
• "Como [algo] funciona"
• "O [qualidade] guia para…"
• "O que é um [substantivo]? Em bom português, por favor."
• "O que exatamente é um [substantivo]?"
• "Por que [algo] é importante?"
• "Aprenda [algo] em N horas"
• "Uma história sobre [algo]"
• "A história por trás de [algo]"

E abaixo temos umas estruturas de títulos que funcionam bem com narrativas pessoais:

• "Como eu [fiz algo]"
• "Eu [fiz algo]. Isso foi o que eu aprendi."
• "Como eu passei de [algo] para [algo diferente] em N anos"
• "Por que eu comecei a [fazer algo]?"
• "Eu nunca [farei algo] novamente. Esse é o motivo."
• "Como eu [fiz algo] sem [alguma coisa]"
• "Por que eu parei de [fazer alguma coisa]?"

Adicione sua imagem de capa

Ao escolher seu título claro e informativo, adicione uma imagem de capa interessante. Clique na engrenagem no canto superior direito.

Alguns dos autores criam sua própria arte de capa para o artigo. Um site gratuito como o Canva.com pode ajudá-lo nesse processo (se quiser evitar que as bordas de suas imagens sejam cortadas quando seu artigo for compartilhado no Facebook ou no Twitter, use uma imagem na proporção de 1,91:1.)

Se você não tiver uma imagem, pode fazer o download de uma imagem que não precise de atribuição em um site como o Pexels, o Unsplash ou a Wikipédia, salvar a imagem e fazer o upload dessa imagem no Ghost.

Não faça links diretos das imagens. Em vez disso, faça o download para o seu computador das imagens que quiser usar, depois arraste-as para o seu artigo no Ghost. Dessa forma, o freeCodeCamp pode servir as imagens por meio dos nossos próprios CDNs confiáveis (para um melhor desempenho e acessibilidade). Tente usar imagens de menos de 1MB.

Defina o URL de sua publicação

Você pode definir o URL de seu artigo diretamente. Recomendamos mantê-los curtos e descritivos, como, por exemplo "tutorial-de-aprendizagem-de-maquina-com-pytorch" ou "de-vendedor-a-desenvolvedor-de-software".

Escolha suas tags

Você pode escolher de uma a cinco tags para seu artigo. Ao escolhê-las, informe a equipe do editorial e adicionaremos essas tags para você.

Elas facilitarão a descoberta pelos leitores de seus artigos por meio da busca e ao procurarem pelas tags.

A primeira tag que você escolher é a mais importante. Ela aparecerá na parte superior de seu artigo, como mostramos abaixo.

Não altere as metainformações do menu. Nossa publicação tem valores padrão ideais para isso.

Dicas para escrever um artigo que as pessoas lerão de verdade

Gramática, ortografia e formatação importam, sim

É mais fácil ler artigos claros e adequadamente formatados. Aqui vão algumas dicas para tornar seus artigos tão legíveis quanto possível:

• Mantenha a simplicidade. Use linguagem simples e direta sempre que possível.
• Use frases curtas. Divida frases maiores em menores. Isso ajuda as pessoas a ler mais rapidamente e a entender melhor.
• Use parágrafos curtos. Divida parágrafos maiores em parágrafos de uma ou duas frases. Muralhas de texto farão seu leitor abandonar o artigo ou mudar para um modo de "passar os olhos rapidamente".
• Use pontuação limpa. Muitos pontos de exclamação podem distrair!!! O ponto-e-vírgula raramente é necessário; use apenas o ponto final. E as reticências são... bem... em geral, um exagero.
• Use subcabeçalhos para estruturar seu texto. Nossa publicação dá a você tamanhos pequenos e grandes de títulos para sua caixa de ferramentas. Use cabeçalhos grandes para os tópicos principais e subcabeçalhos menores para seções dentro desses tópicos.
• Não use negrito, itálico ou ambos em excesso. Excesso de formatação de texto torna difícil a leitura, especialmente se você utilizar negrito e itálico juntos. Use-os separadamente e com cuidado.
• Remova as abreviações. Elas tornam o artigo de difícil entendimento. Escreva a sigla por extenso se ela não for bem conhecida. Torne expressões em latim em expressões no seu idioma, como "e.g." em "por exemplo" e "… etc." em "e assim por diante".

Revise seu artigo. Depois, revise-o de novo.

Alguns autores escrevem rapidamente para colocarem as ideias diretamente no papel (ou na tela). Outros fazem toda a pesquisa antes de escrever uma única palavra.

Seja qual for o seu processo, não se esqueça de deixar seu artigo em paz por algum tempo e depois volte a ele com outros olhos.

Leia seu artigo novamente. Depois, leia-o em voz alta. Você vai se surpreender com os pequenos erros, erros de digitação e frases estranhas que você perceberá.

Adicione o destaque de sintaxe ao seu código

Você pode criar um bloco de código digitando três crases (```) e depois pressionando a barra de espaço.

Você pode até especificar a linguagem de programação para a qual você quer o destaque de sintaxe.

Por exemplo, ao digitar ```js, você terá o destaque de sintaxe para JavaScript. Também damos suporte à destaque de sintaxe para uma dezena de outras linguagens de programação populares.

Mantenha-se no assunto

O tempo do leitor é finito. Ajude o leitor a retirar o máximo possível de valor de seus artigos antes de ele seguir adiante.

Mantenha seus artigos técnicos com profundidade o mais "passo a passo" possível

1. Escreva uma introdução concisa, que diga aos leitores o que eles podem obter.
2. Use uma lista numerada como essa para indicar os passos.
3. Insira tantos detalhes quanto puder.
4. Encerre lembrando os leitores do que acabam de aprender.

Conte suas histórias pessoais como se fossem um romance

Mesmo que seu título provavelmente já denuncie o final de sua história ("Como eu passei de caminhoneiro a desenvolvedor de software em 2 anos"), você ainda pode contar a história como se fosse um romance.

Em vez de fazer saltos no tempo, comece do início, desenhando um retrato de sua vida antes, durante e depois de sua jornada.

Veja se consegue orientar sua história ao redor de um conflito central. Por exemplo, como vencer:

• desafios da imigração
• entrevistas de emprego intensas
• problemas de aprendizagem
• discriminação relativa à idade
• ou a boa e velha mania de deixar tudo para depois (um dos desafios mais comuns)

O conflito é fundamental para a narrativa. Livros e filmes são interessantes por causa do conflito entre os personagens e seu ambiente ou até entre eles mesmos.

Escreva artigos maiores e mais abrangentes em vez de artigos em várias partes

Observamos várias vezes que as pessoas não se importarão de ler a segunda, terceira, quarta ou a enésima parte de uma série se não tiverem lido todas as partes anteriores.

Ao mesmo tempo, percebemos que artigos longos e de profundidade funcionam incrivelmente bem. As pessoas colocarão o artigo entre seus favoritos ou compartilharão o artigo nas mídias sociais para poderem voltar a ele.

Quando as pessoas percebem que um artigo é longo, em geral concluirão que o artigo é sério e abrangente. Isso inspira as pessoas a começarem devagar e a dedicarem o tempo para a leitura do artigo. Muitos até abrirão o editor de código para programar junto com o artigo em casa.

Mantenha o artigo o mais "censura livre" possível

A comunidade do freeCodeCamp é composta, em sua maioria, de adultos, mas também pode haver crianças nela.

Se estiver escrevendo sobre algum tópico como assédio sexual, não há uma maneira de manter o tópico "apropriado para o público infantil". Na maioria dos casos, contudo, isso é possível.

Tente não usar linguajar de baixo calão a menos que seja em uma citação direta e mantenha distância de memes potencialmente ofensivos.

Por fim, se parecer que um artigo viola o código de conduta do  freeCodeCamp, nós o excluiremos imediatamente. Guardaremos, no entanto, uma cópia dele e a enviaremos para você para nosso próprio registro e de modo que você não perca seu trabalho.

Use imagens que não necessitam ser atribuídas ou imagens que você mesmo criou

Você pode incluir instantâneos e outras imagens que você mesmo criou. Contudo, se você não tem os direitos de uso de uma foto, use uma imagem semelhante e que não precise ser atribuída no lugar. Essas não necessitam de atribuição nem de taxas de licenciamento.

Alguns sites da web onde você pode encontrar essas imagens são o Pexels, o Unsplash e a Wikipédia.

Não faça links diretos para as imagens. Em vez disso, faça o download das imagens que você quer usar para o artigo e depois arraste-as para o Ghost. Desse modo, freeCodeCamp pode servir as imagens por meio de seus CDNs confiáveis (para um melhor desempenho e acessibilidade). Pedimos que mantenha o tamanho das imagens inferior a 1MB.

Algumas imagens – como as webcomics – são criadas tendo em mente o compartilhamento. Para essas, você pode inserir a imagem e dizer "Crédito pela imagem: XKCD" com um link para a página específica da webcomic.

Sempre credite suas fontes e não plagie

O plágio ocorre quando alguém representa o que foi escrito (ou a imagem, o código e assim por diante) por outra pessoa erroneamente como seu. É um crime sério e pode demitir pessoas de empregos ou expulsá-las das escolas. Nas publicações do freeCodeCamp, também levamos isso a sério.

Poucas pessoas já tiveram a coragem de tentar plagiar em uma publicação do freeCodeCamp. Ainda assim, houve algumas esses últimos 6 anos. Nós as descobrimos, removemos seus artigos e as retiramos da comunidade para sempre.

Não se preocupe – você não plagiará nada por acidente. O plágio é um ato intencional.

Como citar suas fontes corretamente

Se estiver parafraseando (ou citando diretamente) algo dito por outra pessoa em um artigo, vídeo, curso ou alguma outra mídia, é preciso dar crédito a elas. Isso significa adicionar um link à fonte original e usar o formato de citações, da seguinte maneira:

"Este jogo é controlado inteiramente por meio de digitação em uma interface de linha de comando. Como o jogo é em tempo real por natureza, isso pode levar a momentos intensos de digitação rápida de comandos ao tentar salvar seus drones do perigo." (Fonte: Quincy Larson)

Isso inclui texto (ou código) retirado de documentação oficial, do StackOverflow, do GitHub e de recursos semelhantes. Se você estiver copiando e colando de uma fonte assim, não se esqueça de citá-la e de adicionar um link para ela.

Sempre atribua as citações às pessoas que as disseram originalmente. Se for uma citação com várias linhas, use o modelo de citação, como no caso abaixo, para segmentar parágrafos maiores:

“Quando você tem talento próprio, é um prazer dar crédito para o talento dos outros.”
― Criss Jami

Se o seu código é, em grande parte, inspirado (ou tomado emprestado do) código de outras pessoas, dê crédito a elas.

Antes de publicar um artigo que reflita muito o trabalho de outras pessoas, pergunte-se: o meu artigo estende substancialmente o trabalho daquela pessoa? Caso contrário, talvez o artigo não valha a pena.

Uma última observação sobre utilizar o trabalho de outros: sempre é melhor usar o que é seu quando você puder. Desse modo, em vez de copiar/colar e citar fontes em excesso, tente absorver as informações e explicá-las com suas próprias palavras. Isso ajudará você a entender melhor e evitará que você se arrisque a plagiar o trabalho de outros.

Porém, se você precisar citar ou pegar emprestado de outra fonte, certifique-se de citá-la adequadamente.

Alguns exemplos de plágio

Aqui vão alguns exemplos de plágio – ou seja, do que não se deve fazer. O primeiro deve ser bem claro (a cópia palavra por palavra):

Texto original:

Apenas uma observação rápida antes de começarmos: a interface de desktop e do aplicativo móvel do Instagram são bem diferentes. A maioria das pessoas usar o Instagram pelo dispositivo móvel (a partir do app do Instagram) porque é lá que você pode publicar as fotos de fato. (Fonte: Abbey Rennemeyer)

Texto plagiado:

Ok, todos prontos para aprender sobre o Instagram? Vamos lá!

Apenas uma observação rápida antes de começarmos: a interface de desktop e do aplicativo móvel do Instagram são bem diferentes. A maioria das pessoas usar o Instagram pelo dispositivo móvel (a partir do app do Instagram) porque é lá que você pode publicar as fotos de fato.

Agora que já esclarecemos isso, podemos continuar.

Como você pode ver, o texto plagiado está colocado entre trechos de texto original. É tentador adicionar frases ou parágrafos que alguém escreveu muito bem. Mas, a menos que você cite sua fonte, isso configura plágio.

O segundo exemplo, abaixo, pode não parecer tanto assim com plágio. Mas parafrasear as palavras de alguém de modo muito semelhante ainda é considerado plágio.

Texto original:

Há diversas razões para querer compartilhar fotos e vídeos no Instagram.

Talvez você esteja começando uma empresa ou lançando um produto. Você pode trabalhar para uma empresa que quer ter uma presença no Instagram. Talvez você queira criar sua marca pessoal como fotógrafo, viajante ou artista. Ou talvez só queira compartilhar seus interesses do momento por meio de fotos.

Seja qual for o motivo, o Instagram é um ótimo lugar para compartilhar ideias, trocar mensagens e compartilhar sua arte on-line. (Fonte)

Texto plagiado:

Existem vários motivos para compartilhar fotografias e vídeos no Insta.

Pode ser que você esteja começando seu próprio negócio ou lançando algum produto. Talvez você trabalhe para uma organização que deseje ter uma presença no Instagram. Ou talvez seja sua intenção criar sua própria marca. Quem sabe você esteja pensando em mostrar o que está fazendo agora por meio de fotos.

Independentemente da razão, o Instagram é um lugar interessante para publicar essas ideias, mensagens ou obras artísticas on-line.

Como você pode ver, o texto acima é "fortemente baseado" no texto original. Pode ser que algumas palavras tenham mudado ou tenham sido removidas, mas está claro que a pessoa não o escreveu por conta própria. Outra vez, isto não é correto e seria considerado plágio.

Se tiver perguntas sobre o que constitui o plágio, faça uma pesquisa e verifique se você sabe como citar adequadamente as fontes e como criar conteúdo original.

Nada de publicações cruzadas.

Publicações cruzadas (uma publicação fazendo referência à outra e vice-versa) em geral é ineficaz. Se você quer que muitas pessoas leiam seu artigo, recomendamos que você publique o artigo em uma única publicação – seja no freeCodeCamp, em seu próprio blog ou em uma revista on-line.

Algumas exceções a esse caso são:

• Pode valer a pena fazer a publicação cruzada entre artigos dentro de um "jardim cercado" (não indexado pelo Google) como o LinkedIn e o Facebook.
• Se quiser dar destaque ao seu próprio trabalho escrito feito em outras publicações no seu blog para que empregadores em potencial possam vê-lo, você pode fazer a publicação cruzada no seu blog e usar um URL típico apontando para a publicação original. Isso reduzirá a probabilidade de o Google se confundir e mostrar a versão incorreta em seus resultados.

Você pode, no entanto, pegar algumas de suas publicações do blog pessoal sobre um tópico semelhante (como "plug-ins do Visual Studio" ou "Comandos avançados do Bash") e fazer uma antologia deles em um único artigo mais extenso do freeCodeCamp.

Nossa filosofia é: como passaremos horas treinando você quanto ao seu artigo, editando-o meticulosamente e publicando o artigo para a comunidade mais abrangente do freeCodeCamp, pedimos que não faça a publicação cruzada do artigo em sites de publicação aberta, como o Medium.

Maneiras aceitáveis de fazer a autopromoção em seus artigos

O freeCodeCamp.org é uma organização sem fins lucrativos que recebe suporte de seus doadores. Não queremos dar a impressão de fazer “colocação paga” (não fazemos isso) já que isso poderia desencorajar as pessoas de fazer suas doações.

Ao mesmo tempo, entendemos completamente o fato de você querer publicar seu livro, curso ou aplicação SaaS mais recente, ou ainda querer convencer as pessoas a participar de sua lista de e-mails ou a seguir você no Twitter.

Pedimos apenas que você faça isso com bom tom. Está bem colocar uma frase ao estilo call-to-action para o seu produto ao final do artigo.

Não abra seu artigo, no entanto, já fazendo um link para o produto, pois da a ideia de spam. Também não use links afiliados em seus artigos a menos que sejam links para cursos e livros que você tenha criado pessoalmente.

Observe, também, que não permitimos contas "de marca". Proibimos qualquer tipo de ghost writing (escrita em nome de outros). Não transferiremos artigos de um colaborador de uma empresa para outro.

Pedimos também que você não escreva histórias em nome de outras pessoas que ainda não receberam uma conta de colaboradores do freeCodeCamp.

Observe que, para fins de sua própria SEO – diferente do que ocorre na maioria dos sites da web populares – todos os links de nossas publicações são rel="doFollow". Isso significa que sim – toda página que você associar ao seu artigo (incluindo seu próprio blog) receberá um impulso nas classificações do Google. Tenha isso em mente e não exagere os links.

Finalizando o processo

Quando se sentir confiante de que sua história está pronta para os leitores, envie um e-mail com o link do seu texto inicial para editorial@freecodecamp.org. Nossa equipe editorial vai analisar o texto rapidamente e fazer as edições necessárias para fortalecer ainda mais seu artigo antes de publicá-lo.

O que damos mais importância é o título e os parágrafos iniciais. Se percebermos problemas de formatação do texto ou erros gramaticais, corrigiremos isso também.

Se ainda acharmos que o artigo precisa ser mais bem trabalhado, informaremos isso a você e você poderá enviá-lo novamente assim que tiver feito as alterações.

Outras dicas úteis

Markdown do GitHub

Sabia que você pode usar o markdown do GitHub para compor seus artigos?

Você pode colar o markdown em /news e ele será convertido em rich text instantaneamente.

Você também pode digitar a sintaxe de markdown no início de uma linha - por exemplo, # ou ## para títulos ou * para uma lista de itens – e depois começar a digitar o texto em si. O texto receberá o formato especificado.

Devagar com o conteúdo incorporado

Você por incorporar (fazer o "embedding") de coisas como tuítes e vídeos do YouTube se quiser. Basta clicar no ícone de "+" no início de uma nova linha e escolher entre uma variedade de ferramentas de incorporação de conteúdo.

Dito isso, encorajamos você a usar isso com cuidado por três razões:

1. Os embeds chamam um serviço externo, como o Twitter, o que pode tornar a experiência mais lenta
2. Muitas pessoas que lerão a publicação farão isso usando leitores de tela. Uma boa parte da comunidade de desenvolvedores convive com problemas visuais (ou até mesmo com a cegueira completa). Embeds são menos acessíveis que texto.
3. Cada artigo da publicação tem uma versão para páginas de dispositivos móveis aceleradas. Os embeds podem não ser exibidos adequadamente por lá.

Se você ainda não tiver uma conta de colaborador, você pode solicitar uma aqui.

Obrigado por compartilhar suas ideias com a comunidade de desenvolvedores.

Esperamos que este guia ajude você a escrever artigos melhores para que toda a comunidade possa se beneficiar com suas ideias.

Feliz programação!

— Equipe editorial do freeCodeCamp