Obrigado por compartilhar sua experiência e ideias com a comunidade de desenvolvedores.

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.

CSS_Border_-_Style_and_HTML_Code_Examples

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

s_EA15EAEBBDBE9BEF4C3D26DF54B95A0F78DFF7161B00A1CBA39C902CEFE65510_1563853749625_Editor_-_Developer_News

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.

s_EA15EAEBBDBE9BEF4C3D26DF54B95A0F78DFF7161B00A1CBA39C902CEFE65510_1563910312520__Untitled__-_Developer_News

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.

s_EA15EAEBBDBE9BEF4C3D26DF54B95A0F78DFF7161B00A1CBA39C902CEFE65510_1563910227344__Untitled__-_Developer_News

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