guideline.md

Diretrizes para submissão de posts no Medium da comunidade

Este documento tem como objetivo instruir usuários a escreverem um post técnico para a comunidade. A equipe de editores poderá te auxiliar a estruturar o post caso precise.

Posts que não respeitarem o guidelines não serão publicados.

Tema

Sobre o que devo escrever?

• Procure resolver um problema.
• Pense em escrever um post que gostaria de ter encontrado quando enfrentou aquele problema.
• Compartilhe sua experiência. Mesmo que ache que já existem outros posts sobre um determinado assunto, esta será a sua visão e ela poderá ajudar outras pessoas.
• Caso ainda esteja sem ideias mas queira gerar conteúdo, você encontrará sugestões de temas aqui.

Post

• Adicione códigos de exemplo sempre que possível para auxiliar quem está lendo a entender melhor o seu ponto.
• Caso o seu trecho de código passe de 5 linhas, considere adicionar um Gist.
• Escreva uma introdução que cative a pessoa que estará lendo.
• Estruture bem o post. Além dele ter um começo, meio e fim, utilize subtópicos ou listas para a leitura ficar organizada.
• Utilize uma boa imagem no topo do post. Provavelmente será a primeira coisa que irá chamar a atenção do leitor.
• Se possível, não ultrapasse o limite de 7 minutos de leitura. Posts de 4 a 7 minutos serão menos cansativos para leitura. Se o seu post estiver passando este limite, considere quebrá-lo em partes.

Escrita

• Seja objetivo. Siga uma linha de pensamento para que a pessoa não perca o interesse.
• Atenção na gramática. Seja atencioso ao português e se achar necessário utilize ferramentas externas de correção de texto.
• Não utilize nomes pejorativos.
• Deixe todas palavras em inglês e/ou que represente um nome próprio em itálico.
• Escreva frases curtas e que não cansem o usuário.
• Sempre que possível, dê preferência para uma linguagem neutra respeitando as diferentes pessoas da comunidade.

Referências

Referências e exemplos ajudaram o post a ser melhor compreendido pelo leitor.

• Adicione referências externas e oficiais, principalmente ao citar ferramentas ou pessoas.
• Se fizer sentido, adicione um código de exemplo.
• Se fizer sentido, adicione print-screens.

Dicas

• O post deve ter um caráter impessoal. Por conta disso, deve-se evitar escrever na primeira ou terceira pessoa do singular. Ou seja, evite usar termos "conforme vimos no item anterior" e use "conforme visto no item anterior", ou, em vez de "dissemos que", "foi dito que" etc.
• Escreva de forma formal. O post representará a comunidade