Skip to content

Latest commit

 

History

History
68 lines (36 loc) · 5.73 KB

iniciativas.md

File metadata and controls

68 lines (36 loc) · 5.73 KB

Iniciativas

A Instruct busca criar iniciativas que possam contribuir com o aprendizado e performance técnica dos colaboradores. Incentivamos continuamente a contribuição com a comunidade e o aprimoramento de todos.


Guia de Trabalho de Conteúdo - GTCON

Os colaboradores interessados podem participar da iniciativa GTCon! O GTCon é o Grupo de Trabalho de Conteúdo realizado quinzenalmente às quintas-feiras em que os colaboradores da Instruct se reúnem para discutir ideias e oferecer sugestões sobre a criação de conteúdos para o blog no site institucional.

Para cada post publicado, o autor recebe um incentivo de R$ 500,00. Se houver coautores, o valor será dividido igualmente entre eles.

Além da visibilidade que o colaborador poderá alcançar com seu conteúdo técnico, também conseguirá contribuir com a comunidade ao mesmo tempo em que aperfeiçoa sua escrita técnica! A ideia é publicar pelo menos 1 artigo em um intervalo de 15 dias.

O desenvolvimento de cada publicação é feito utilizando o Netlify CMS. Basta fazer login com o GitHub que o colaborador da Instruct já terá acesso imediato! Com este CMS é possível gerenciar de forma simples todo o processo da publicação, desde o rascunho até os que estão prontos para serem publicados. As revisões são feitas no Pull Request que é criado automaticamente no repositório do site institucional toda vez que um novo conteúdo é criado e salvo!

Guia para escrita

Conteúdo técnico geralmente procura responder a uma pergunta específica. Essa pergunta pode ser ampla ou restrita, mas de qualquer forma, nosso objetivo é fornecer respostas sem distração e o mais didático possível.

Para auxiliar na elaboração do seu conteúdo técnico, aqui vão algumas dicas:

Organize seu texto com tópicos

Um texto muito longo e sem divisões que informe de maneira clara e objetiva o que cada seção irá descrever, deixa o conteúdo muito cansativo para quem está lendo. Tente dividir seu texto em tópicos! Os tópicos do seu texto são inseridos automaticamente em um sumário fixo na lateral do post para que facilite ao leitor encontrar alguma sessão específica no seu texto. Portanto, tente deixar mais enxuto e claro possível.

Imagens, tabelas, códigos de exemplo…

Para que o conteúdo fique didático e bem explicado, é interessante que você adicione mídias e exemplos que possam dar um maior auxílio no entendimento, fazendo com que a leitura fique mais dinâmica.

Processo de escrita do conteúdo técnico

De início, você pode começar escrevendo o rascunho do seu conteúdo com o foco unicamente para o desenvolvimento da sua ideia e pontos que quer abordar. Em seguida, podemos lhe ajudar na formatação caso sinta alguma dificuldade. É só irmos identificando as etapas importantes para utilizá-las adequadamente, como a introdução, títulos, seções e outros elementos. Ao finalizar seu rascunho, é só avisar no canal do Mattermost que está pronto para ser revisado que vamos tentar contribuir.

Layout

Todos os conteúdos devem ter o mesmo layout básico:

Introdução

O primeiro parágrafo existe para explicar o que seu conteúdo irá abordar. Certifique-se de que os leitores saibam o que eles terão como resultado ao ler seu conteúdo e informe-os se precisarem de algum pré-requisito específico. Você pode vincular a outras publicações internas nas quais seu post se baseia e adicionar recomendações sobre o que os leitores devem saber. É interessante que você vá direto ao ponto sem muita enrolação.

Desenvolvimento

Esta é uma etapa livre que você pode personalizar de acordo com o que achar melhor. A ideia é que aqui os leitores irão absorver mais profundamente o tema a ser desenvolvido. Cada etapa deve ser construída sobre a anterior até que a etapa final conclua o raciocínio em questão. Não esqueça de tentar deixar o mais didático e dinâmico possível para que a leitura não se torne cansativa.

Conclusão

No final do seu conteúdo, depois que o leitor tiver concluído todas as etapas, você pode adicionar uma breve conclusão. Resuma o que o leitor aprendeu e sugira diferentes ações que ele poderá tomar a partir do que foi apresentado no seu post. É interessante escrever aqui qual impacto ele pode ter após ter lido o que você escreveu.

Você não precisa adicionar o nome Introdução, Desenvolvimento e Conclusão para fazer as separações do layout de conteúdo. A ideia é que a introdução fique implícita e os demais títulos sejam organizados através de tópicos.

Para saber mais

Links para se aprofundar no conteúdo que foi citado durante o texto, algum dado em especifico, data específica, etc

Referências

Pontos de partida, o que deu ideias para seu texto

Dicas para SEO

Para que tenhamos um conteúdo que possa ajudar a impulsionar através dos buscadores do Google, é importante que possamos seguir algumas dicas básicas de SEO:

  • Preencha o texto do ALT das imagens: O ALT é utilizado como uma das informações principais para que o buscador saiba do que a imagem se trata. Escreva textos alternativos relevantes e condizentes com o que a imagem retrata, evitando keyword stuffing e stop words (de, para, com, entre outros). Procure limitar-se a 5 palavras, caso não seja possível, sem problemas! Apenas seja breve e retrate de forma adequada. Quando fizer sentido, empregue as palavras-chaves relevantes do conteúdo;
  • Tente usar as palavras-chaves do seu texto sempre que possível em descrições, tópicos, etc. Cuidado com exageros!
  • Se achar relevante e for possível, tente adicionar links internos que vão de encontro a alguma página do site da Instruct, assim como adicionar links externos nas seções de Para saber mais e Referências