Skip to main content

Cette version de GitHub Enterprise Server ne sera plus disponible le 2024-09-24. Aucune publication de correctifs n’est effectuée, même pour les problèmes de sécurité critiques. Pour de meilleures performances, une sécurité améliorée et de nouvelles fonctionnalités, effectuez une mise à niveau vers la dernière version de GitHub Enterprise. Pour obtenir de l’aide sur la mise à niveau, contactez le support GitHub Enterprise.

Rendre le contenu accessible dans la recherche

Suivez ces meilleures pratiques de SEO pour aider les utilisateurs à trouver la documentation GitHub à l’aide de moteurs de recherche.

À propos de l’optimisation du référencement d’un site auprès d’un moteur de recherche (SEO)

L’optimisation du référencement d'un site auprès d'un moteur de recherche (SEO) est la pratique qui vise à gagner de la visibilité pour le contenu web dans les résultats du moteur de recherche, tels que ceux de Google et Bing. La recherche Google est le principal référent de GitHub Docs et le point d’entrée le plus courant pour nos utilisateurs.

Nous pouvons planifier et écrire notre contenu pour améliorer le SEO. Un meilleur SEO améliore l’expérience des personnes qui recherchent de la documentation, car il leur permet de trouver plus probablement les informations qu’ils recherchent à l’aide de leurs termes de recherche préférés.

Meilleures pratiques pour le SEO de contenu

Un bon SEO nécessite la planification du contenu pour des publics spécifiques et être attentif aux mots qu’ils utilisent pour rechercher. Suivez ces meilleures pratiques pour améliorer le SEO d’un article.

Sélectionnez une audience cible.

Comprendre et écrire u public spécifique pour le contenu : développeurs, administrateurs ou apprenants de code. Ainsi, vous pourrez :

  • Utilisez des mots que vos lecteurs utilisent.
  • Rendez le contenu pertinent pour leurs besoins et leurs tâches.
  • Fournissez la quantité appropriée d’informations de contexte et d’arrière-plan.

Répondre à l’intention de recherche

Créez du contenu autour de l’intention de recherche : la tâche, la question ou le problème qui conduit un membre du public cible à rechercher des informations en ligne.

  • Effectuez des recherches sur les intentions de recherche. Par exemple, analysez les pages de résultats du moteur de recherche (SERP) pour les requêtes pertinentes.
  • Comprenez les besoins de l’utilisateur. Utilisez plusieurs sources telles que les retours d’expérience des clients, les entretiens avec les utilisateurs et les métriques.

Utiliser un langage clair

Suivez les instructions de « Meilleures pratiques pour GitHub Docs », notamment :

  • Vérifiez que chaque article possède un sujet clair et distinct.
  • Placez d’abord le contenu de priorité supérieure dans un article.
  • Structurez les articles avec des titres clairs.
  • Modifiez le contenu pour la cohérence en suivant « Guide de style ».

Incorporer des mots clés

Incorporez des mots clés, ou les principaux termes de recherche utilisés par votre public, dans la copie de pages et les métadonnées. Par exemple, si vous écrivez sur la « facturation », mais que votre public utilise principalement « coût » et « paiement », utilisez ces termes à la place.

Google et Bing offrent tous deux des outils de recherche de mots clés pour vous aider à découvrir des mots clés pertinents. L’équipe Docs consulte également les données de la console de recherche Google pour comprendre les termes de recherche qui mènent à des pages sur GitHub Docs.

Inclure les métadonnées

Utilisez les métadonnées complètes dans les informations préliminaires. Pour afficher les valeurs disponibles, consultez « Utilisation des informations préliminaires YAML ».

Sur GitHub Docs, l’élément intro s’affiche en tant que sous-titre de page et sert de description des métadonnées HTML. Le titre de l’article sert de titre de page HTML. Pour un bon SEO :

  • Écrivez le titre et l’intro pour qu’ils soient complémentaires et riches en mots clés. Réfléchissez à la façon dont ils seront rendus dans la recherche.
  • Accompagnez toutes les images de textes de remplacement riches en mots clés, qui sont également des métadonnées utilisées par les moteurs de recherche. Consultez « Texte de remplacement » dans le guide de style GitHub Docs.

Lier simplement à d’autres pages pertinentes pour la tâche sur GitHub Docs et les sites homologues de haute qualité, en suivant « Liens » dans le guide de style GitHub Docs.

Assurez-vous que les liens entrants ne sont pas cassés en conservant soigneusement les redirections.

Maintenir la précision

Assurez-vous que le contenu est exempt d’erreurs de fait, d’orthographe et de style. Auditez régulièrement le contenu pour supprimer des erreurs telles que des liens rompus et pour mettre hors service tout contenu inutile. Consultez « Configurer des redirections ».