-
Notifications
You must be signed in to change notification settings - Fork 0
Guia de escrita de artigos
Depois de muitos artigos escritos e revisados pelos nossos editores, algumas alterações comuns começaram a aparecer e ficar cada vez mais evidentes. Com base nessas alterações resolvemos escrever um guia de escrita que irá auxiliar os novos e antigos escritores de forma a transformar o processo de criação e escrita de um artigo muito mais padronizado e mais profissional.
Tenha em mente que este documento não é um tutorial e também não é um conjunto de regras. Ele é apenas um guia de boas práticas com dicas e ideias para que a escrita de um artigo seja mais legível e melhor formatada. Desta forma não é necessário que o escritor siga exatamente as ideias que colocamos aqui, mas se basear nesses tópicos para escrever seus artigos fará com que a revisão seja muito mais rápida e os leitores possam entender muito melhor sua mensagem.
Este guia se destina a todos os atuais e futuros escritores da publicação do TC no Medium.
Não só pode como a contribuição é encorajada. Se você tem alguma ideia ou sugestão de como podemos melhorar, ou então quer adicionar, alterar ou remover uma guideline neste guia, então crie um issue no nosso repositório de editorial com o título [GUIA DE ESCRITA] Seu título.
Um artigo é um conjunto de ideias que você, como escritor, quer passar a um conjunto de leitores. Para isto, é necessário que a linguagem utilizada seja simples e fácil de forma que você possa atingir a maior quantidade de pessoas possível.
Tenha em mente que, quando um leitor ler o seu artigo, ele pode estar buscando por uma informação específica ou então pode estar buscando por mais conhecimento sobre um determinado assunto, neste caso temos o que é chamado de leitor direcionado, que já sabe o que quer.
Em outros casos temos o chamado leitor casual, que é o leitor que não estava pretendendo ler o seu artigo, mas por algum motivo (provavelmente o título ou a descrição do mesmo) caiu no seu artigo e quis le-lo.
Em ambos os casos, tenha em mente que podem ser pessoas que não sabem ou não tem o grau de conhecimento necessário para sua imformação, então algumas dicas são:
- Use sempre a linguagem mais simples possível
- Tente exemplificar e utilizar analogias para todas as coisas
- Explique códigos ou qualquer situação específica do seu artigo logo depois de adiciona-los
- Use listas
- Use fontes e links externos
- Se houve gifs ou vídeos, utilize-os a seu favor
- Todos os seus artigos devem conter uma imagem de capa, se ele não contiver, provavelmente um editor irá notificar você para adicionar uma. Enquanto a imagem de capa não estiver colocada, o artigo ficará em espera
- A imagem de capa deve ser sempre a primeira coisa em seu artigo, com o texto vindo logo abaixo dela. Antes da imagem recomendamos que não haja nenhum texto.
- Evite usar "abaixo", "ao lado" e "acima" na hora de localizar elementos na página (como em: "No exemplo ao lado" ou "Na imagem acima"), isto porque em resoluções diferentes seu artigo terá disposição diferente dos itens nele escritos, então "ao lado" ou "abaixo" podem não existir nestes contextos. Procure sempre utilizar "a seguir" e "anterior" (e variações do mesmo).
- Sempre adicione Tags nos seus artigos. O limite máximo é de 5 tags por artigo, mas pedimos que os escritores adicionem apenas 3, pois os editores irão adicionar 2 tags padrões do TC para indexação
- Prefira tags com maior número de artigos, pois estas tags tem mais relevância no cenário geral, por exemplo, a tag "Tecnologia" pode ter 7500 artigos publicados, enquanto a tag "Technology" tem 174.000, portanto a tag em inglês é preferível, uma vez que ela será melhor indexada na plataforma.
- Artigos enviados em inglês, ou em qualquer outra língua, devem ser enviados junto com sua versão em português. Artigos que somente contém a versão internacional não serão publicados até que sua contraparte seja enviada.
- Estudos comprovam que o artigo ideal no Medium tem 7 minutos de leitura, portanto, se seu artigo estiver ficando muito grande, não hesite em parti-lo em duas ou mais partes.
- Se seu texto for partido em mais de uma parte, começe a parte seguinte sempre com um link para a primeira parte ou para a parte anterior
- Outra boa dica é adicionar no final o link para a próxima parte também
- Seu artigo é uma aula por si só, seja o que você quer ensinar ou passar para seu leitor, faça-o de forma moderada, pouco a pouco, dê exemplos a cada 2 ou 3 parágrafos, evite muitas sequências contínuas de texto.
- Inclua referências e fontes para seu artigo no final do mesmo
- Evite usar muitas palavras em negrito no mesmo parágrafo, isto polui muito o texto e diverge a atenção do leitor para outras partes do mesmo.
- Quando uma palavra em outra língua aparecer pela primeira vez no texto, escreva-a em itálico identificando que aquela palavra não pertence a língua.
O Medium possui dois tipos de citações, o primeiro estilo é parecido com o modelo a seguir do próprio github:
Esta é uma citação do estilo 1
Este tipo de citação deve ser utilizado quando se quer incluir uma nova informação adicional que não tem a ver com o texto original, um adendo ao conteúdo. Por exemplo:
Para instalar o Docker basta baixar o instalador para Windows no site oficial
Caso você esteja tendo problemas com a instalação do Docker, refira ao seguinte link
O segundo modelo é um destaque maior do que outras partes do parágrafo. Este tipo de citação somente deve ser utilizada quando um pedaço do texto deve conter um destaque muito grande sobre os demais, ou então para fins estéticos (como incluir a citação de algum autor no meio do texto).
O Medium possui dois tipos de títulos: O primário e o secundário. O título primário deve ser utilizado sempre quando não houve nenhum outro secundário no texto, em outras palavras, evite utilizar títulos secundários como separação de partes no texto se eles não estiverem aninhados em nenhum outro título primário.
Por exemplo, ao iniciar o texto e houver uma seção "Introdução", escreva-a utilizando o primário. Algumas boas práticas:
- Um título primário não pode aparecer aninhado em um secundário
- Um título secundário só pode existir se estiver aninhado em um primário
- Dois títulos primários subsequentes irão criar duas seções separadas
- Dois títulos secundários aninhados subsequentes irão criar duas subseções de uma seção definida por um título primário
- Não utilize títulos para realçar texto
- Evite escrever títulos primários com mais de uma linha
- Evite usar imagens grandes no meio de um texto. Imagens grandes devem ser utilizadas como fotos de capa
- Procure posicionar a imagem sempre no meio do texto e não nas laterais, pois nas versões mobile do seu artigo, o posicionamento lateral será substituído pelo posicionamento intercalado.
- Sempre adicione uma legenda a sua foto, isto torna seu artigo muito mais acessível a leitores de tela
- Se a foto ou imagem não é sua, adicione a fonte na legenda no formato
Legenda (Fonte: <link>), o link da legenda pode ser escrito por extenso (se não for muito longo) ou então substituído por uma palavra, por exemplo,Legenda (Fonte: https://uol.com.br)eLegenda (Fonte: UOL)(sendo a palavra "UOL" um link para o site).
- Evite criar parágrafos muito longos, este tipo de parágrafo desmotiva os leitores a continuar lendo seu texto, procure sempre manter um parágrafo com, no máximo, 6 linhas.
- Inclua imagens, gifs, citações, códigos, exemplos ou subdivisões (o Medium possui uma linha horizontal nativa) entre longas partes de texto contínuo, ou seja, não escreva somente texto por mais de 20 linhas, isto faz com que a leitura se torne cansativa e pouco produtiva.
- Separe seu artigo em seções, uma boa ideia é iniciar o mesmo por um parágrafo inicial com uma chamada (pois isto será o resumo gerado automaticamente pelo Medium), seguido de um título primário de "Introdução", onde você irá começar a desenrolar o assunto, por fim, ao finalizar, crie uma seção "Conclusão" e termine com uma despedida.
- Nunca inclua código em blocos utilizando o editor do Medium, sempre adicione um gist com seu código incluso. Para isto basta criar o gist e copiar a URL para o mesmo, colando a URL (em texto plano mesmo) no local aonde seu bloco de código estará, ao pressionar ENTER, o Medium irá substituir a URL pelo Gist (veja o tutorial aqui).
- Código inline deve ser adicionado utilizando backticks (`) assim como no github ou em outros editores markdown, evite usar itálico para incluir pedaços inline de código (veja este artigo para melhores informações sobre como adicionar código inline no Medium)
- Procure sempre explicar o código depois do bloco adicionado.
- Utilize listas sempre que precisar descrever pontos específicos de alguma parte do artigo adicionando
-e um espaço antes do texto da lista - As listas do Medium não tem títulos, então é uma boa prática colocar a primeira parte da lista, se aplicável, como o título do ponto em questão, como no exemplo a seguir:
- Título: Descrição
- Titulo2: Descrição 2
Como dissemos antes, este guia não é um conjunto de regras que devem ser seguidas a risca, muito menos fixadas em pedra. A cada dia este guia poderá sofrer novas alterações e novas adições, então fiquem ligados para o que pode acontecer por aqui.
O objetivo final deste guia é tornar a escrita mais simples e padronizada entre todos os artigos da publicação e também facilitar a leitura dos mesmos para quem estiver interessado.
Seguido estas dicas e sendo criativo, teremos sempre os melhores resultados :)