Sobre a SEO (otimização do mecanismo de pesquisa)
A otimização do mecanismo de pesquisa (SEO) é a prática de obter visibilidade para o conteúdo da web nos resultados dos mecanismos de pesquisa, como os do Google e do Bing. A pesquisa do Google é o principal referenciador para GitHub Docs e o ponto de entrada mais comum para nossos usuários.
Podemos planejar e escrever nosso conteúdo para melhorar a SEO. Uma SEO melhor melhora a experiência das pessoas que pesquisam a documentação, pois aumenta a probabilidade de encontrarem as informações que procuram usando seus termos de pesquisa preferidos.
Melhores práticas para SEO de conteúdo
Uma boa SEO requer planejamento de conteúdo para públicos específicos e estar atento às palavras que eles usam para pesquisar. Siga estas melhores práticas para melhorar a SEO de um artigo.
Selecione um público-alvo
Entenda e escreva para o público específico do conteúdo: desenvolvedores, administradores ou aprendizes de código. Isso ajuda você a:
- Use palavras que seus leitores usam.
- Torne o conteúdo relevante para suas necessidades e tarefas.
- Forneça a quantidade certa de contexto e informações básicas.
Responder à intenção de pesquisa
Crie conteúdo em torno da intenção de pesquisa: a tarefa, pergunta ou problema que leva um membro do público-alvo a pesquisar informações online.
- Realizar pesquisas de intenção de pesquisa. Por exemplo, analise as páginas de resultados do mecanismo de pesquisa (SERPs) em busca de consultas relevantes.
- Entenda as necessidades do usuário. Use várias fontes, como feedback do cliente, entrevistas com usuários e métricas.
Usar uma linguagem clara
Siga as diretrizes em Melhores práticas para documentos do GitHub, incluindo:
- Certifique-se de que cada artigo tenha um tópico claro e discreto.
- Coloque o conteúdo de maior prioridade em primeiro lugar em um artigo.
- Estruture os artigos com títulos claros.
- Edite o conteúdo para manter a consistência seguindo o Guia de estilo.
Incorporar palavras-chave
Incorpore palavras-chave ou principais termos de pesquisa usados pelo seu público na cópia da página e nos metadados. Por exemplo, se você estiver escrevendo sobre "faturamento", mas seu público usar principalmente "custo" e "pagamento", use esses termos.
O Google e o Bing oferecem ferramentas de pesquisa por palavras-chave para ajudá-lo a descobrir palavras-chave relevantes. A equipe do Docs também consulta os dados do Google Search Console para entender quais termos de pesquisa levam a páginas em GitHub Docs.
Incluir metadados
Use metadados completos no frontmatter. Para ver os valores disponíveis, consulte Usar front matter YAML.
Em GitHub Docs, o elemento intro é exibido como um subtítulo na página e serve como a descrição de metadados HTML. O título do artigo serve como título da página HTML. Para uma boa SEO:
- Escreva o título e
intropara que seja complementar e rico em palavras-chave. Considere como eles serão renderizados na pesquisa. - Acompanhe todas as imagens com texto alternativo rico em palavras-chave, que também são metadados usados pelos mecanismos de pesquisa. Consulte Texto alternativo no Guia de Estilo GitHub Docs.
Criar links de forma estratégica
Crie links frugalmente para outras páginas relevantes para tarefas em GitHub Docs e sites de mesmo nível de alta qualidade, seguindo Links no Guia de Estilo GitHub Docs.
Certifique-se de que os links de entrada não sejam comprometidos mantendo cuidadosamente os redirecionamentos.
Manter a precisão
Certifique-se de que o conteúdo esteja livre de erros de fato, ortografia e estilo. Audite o conteúdo periodicamente para remover erros, como links quebrados, e para retirar conteúdo desnecessário. Confira Configurar os redirecionamentos.