Skip to main content

Enterprise Server 3.21 est actuellement disponible en tant que version candidate.

Type de contenu de prise en main

Le contenu de prise en main fournit les informations essentielles minimales pour utiliser un produit ou une fonctionnalité.

Le contenu de démarrage sert de point d’entrée pour utiliser les produits et fonctionnalités de GitHub. Cette section ne doit contenir que les informations essentielles minimales dont un utilisateur a besoin avant de passer aux concepts et aux guide pratique. Nous faisons cela pour être concis, et aussi il ne semble pas compliqué de commencer avec une fonctionnalité.

Considérations pour bien démarrer

La section Prise en main regroupe des articles faciles à parcourir rapidement. Il doit contenir moins de 5 articles, et idéalement seulement deux :

  • Démarrage rapide
  • À propos de [PRODUCT] (ou « Qu’est-ce que [PRODUIT] »)

L’une des exceptions à ceci peut être avec des plans et des informations de facturation disponibles, où de telles informations sont requises pour utiliser le produit ou la fonctionnalité.

Pour plus d’informations sur le contenu du démarrage rapide, consultez Type de contenu de démarrage rapide.

En particulier, les articles contenant ces informations ne relèvent pas de Prise en main :

  • Articles qui relèvent du type de contenu « procédure ».
  • Étapes de configuration ou d’inscription : ce sont également des procédures. Ils documentent comment faire quelque chose dans l’interface utilisateur.
  • Contenu utile pour la prise en main d’une fonctionnalité particulière, mais pas dans toute la zone de produit. Ce type de contenu appartient plus correctement aux concepts.
  • Meilleures pratiques, généralement. Les utilisateurs nouveaux à une fonctionnalité n’ont pas le contexte nécessaire pour tirer le meilleur parti de ces fonctionnalités.