Le contenu procédural permet aux utilisateurs d’effectuer une tâche du début à la fin quand ils utilisent GitHub.
Nous créons des articles procéduraux et des sections procédurales dans des articles plus importants.
Comment écrire des articles procéduraux
Pour le modèle de contenu procédural, consultez Modèles.
- Suivez les consignes de style pour les étapes procédurales dans Guide de style.
- Le contenu procédural pouvant devenir répétitif, voyez s’il est possible de regrouper des contenus connexes dans un seul article plus long.
- Regroupez plusieurs procédures associées dans un seul article, sauf si une raison spécifique vous empêche de 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 implication 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 contenant les deux procédures. Utilisez un titre indépendant.
- Indiquez aux lecteurs le résultat attendu de la procédure.
- Incluez des conseils de dépannage le plus souvent possible.
Titres pour les contenus procéduraux
- Les articles procéduraux ou les sections procédurales dans des articles sont basés sur des tâches et commencent par un substantif.
- Utilisez : « Demande d’un pack de développement étudiant »
- Utilisez des verbes actifs et spécifiques (faites un brainstorming 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.
- Longueur du titre de l’article : 80 caractères maximum, 60 si possible.