Les procédures contiennent des étapes numérotées qui décrivent comment utiliser le produit GitHub pour accomplir une tâche. En règle générale, ils sont nécessaires pour tirer le meilleur parti de l’utilisation GitHub.
Les articles pratiques se concentrent sur les étapes essentielles minimales pour effectuer une tâche. Ils peuvent être liés à d’autres types de contenu en tant que prérequis (en particulier des concepts ou des références) ou des étapes suivantes (en particulier des didacticiels). Conformément à notre stratégie de liaison, celles-ci doivent être utilisées uniquement lorsqu’elles sont explicitement utiles et nécessaires.
En règle générale, inclure 1 à 2 phrases d'introduction brèves avant les étapes est acceptable. Si d’autres explications au-delà d’un couple de phrases sont nécessaires, envisagez d’ajouter les informations plutôt qu’un article conceptuel.
La résolution des problèmes est son propre type de contenu, mais les articles pratiques peuvent inclure de courtes sections de résolution des problèmes où cela aide les personnes à effectuer la tâche.
Titres des articles pratiques
Les titres et les sections des articles de procédures sont basés sur des tâches et commencent par un gerund.
- Utiliser : « Application pour un pack de développement étudiant » Utilisez des verbes actifs et spécifiques (brainstorm ou utilisez un dictionnaire des synonymes si nécessaire). Les titres décrivent spécifiquement la tâche contenue dans l’article ou l’en-tête, mais ils sont suffisamment généraux pour refléter tout le contenu.
Les titres courts des articles d'instructions utilisent des expressions verbales courtes et sans gérondif. Les titres courts apparaissent dans la barre de navigation latérale.
- Utiliser : « Gérer votre plan » ou « Créer des problèmes avec Copilot »
Considérations relatives au guide pratique
Pour le modèle de contenu de procédure, consultez Modèles.
- Suivez les consignes de style pour les étapes procédurales dans Guide de style.
- Le contenu de procédure peut être répétitif : recherchez des opportunités de regrouper le contenu associé dans un seul article plus long.
- Regroupez plusieurs how-tos connexes dans un seul article, sauf s’il existe une raison convaincante de ne pas le faire.
- Si la désactivation d’un paramètre ou l’annulation d’une tâche nécessite les mêmes étapes et n’a aucune incidence particulière, n’écrivez pas de procédure distincte.
- Si la désactivation d'un paramètre ou l'annulation d'une tâche nécessite des étapes différentes ou a des implications importantes ou spéciales, créez un article plus long pour couvrir ces deux procédures.
- Incluez toujours le résultat prévu du guide pratique (généralement il s’agit du titre).
- Incluez des conseils de dépannage dans les points problématiques connus.
Exemples de contenu pratique
*
[AUTOTITLE](/copilot/how-tos/provide-context/use-copilot-spaces/create-copilot-spaces)