Les guides de démarrage rapide permettent aux utilisateurs d’effectuer rapidement une tâche discrète et ciblée. Pour cela, ils présentent uniquement les étapes essentielles d’un workflow en cinq minutes ou 600 mots environ. Les guides de démarrage rapide peuvent servir à configurer rapidement un nouvel outil ou à effectuer rapidement une autre tâche. Pour les tâches plus complexes, utilisez un tutoriel.
Les démarrages rapides sont utiles lorsque quelqu’un comprend déjà la fonctionnalité ou le produit et est prêt à l’essayer.
Nous regroupons les tutoriels et guides de démarrage rapide sous l’appellation collective de « guides » sur le site. Dans les pages de destination /guides, nous incluons des tutoriels, des guides de démarrage rapide et certains articles procéduraux dans la liste des guides pour un ensemble de documents.
Comment écrire un guide de démarrage rapide
Pour le modèle de démarrage rapide, consultez Modèles.
Contenu des guides de démarrage rapide :
- Introduction :
- Souligne que ce guide est rapide et précis en utilisant des formulations telles que celles-ci :
- Ajouter rapidement [FONCTIONNALITÉ] à votre projet
- Éléments essentiels pour bien démarrer avec [PRODUIT]
- Guide abrégé pour les personnes qui connaissent déjà [FONCTIONNALITÉ]
- Précise l’audience
- Indique clairement les prérequis et les connaissances préalables nécessaires
- Indique ce qu’une personne pourra accomplir ou générer
- Souligne que ce guide est rapide et précis en utilisant des formulations telles que celles-ci :
- Sections procédurales
- En fonction de l’audience du guide de démarrage rapide, les étapes peuvent être moins explicites et formelles que celles précisées dans le contenu procédural. Vous n’avez pas besoin d’utiliser des éléments réutilisables existants pour former ces étapes si l’audience n’a pas besoin de ce niveau de détail.
- Créez des liens vers d’autres articles ou ressources plutôt que de les reproduire, afin d’éviter d’interrompre le flux d’informations.
- Donnez des signaux visuels. Utilisez des blocs de code et des captures d’écran pour rassurer les utilisateurs sur le fait qu’ils effectuent les actions appropriées.
- Résolution des problèmes (facultatif)
- Si un contenu de dépannage pertinent existe pour le guide de démarrage rapide, fournissez des liens vers celui-ci.
- Étapes suivantes
- Fournissez un récapitulatif des tâches accomplies dans le guide de démarrage rapide avant de passer aux étapes suivantes.
- Incluez 2 à 3 étapes actionnables qu’un utilisateur peut entreprendre une fois le guide de démarrage rapide terminé. Ajoutez toujours un lien vers le contenu conceptuel sur la fonctionnalité ou le produit. Vous pouvez également créer un lien vers d’autres informations connexes sur docs.github.com ou dans GitHub Skills.
Instructions relatives aux titres pour les guides de démarrage rapide
- Quand le guide aide un utilisateur à bien démarrer avec un nouvel outil, faites précéder le titre de « Démarrage rapide », par exemple : « Démarrage rapide pour GitHub Actions » ou « Démarrage rapide : Titre procédural ».
- Pour les autres cas d’usage, suivez les instructions relatives aux titres des procédures et omettez « Démarrage rapide ».