Modèle d'article de dépannage
par Atlassian
Documentez des problèmes courants et la manière de les résoudre

Aidez les clients à résoudre les problèmes courants et à trouver des solutions par eux-mêmes en rédigeant des articles de dépannage. Notre modèle d'article de dépannage vous donne la structure dont vous avez besoin pour articuler le problème, détailler la solution et afficher les articles connexes (ce que vous pouvez faire automatiquement en utilisant des étiquettes et la macro « content-by-label » pour garder une trace des articles connexes). Apprenez-leur les ficelles du métier et donnez à votre équipe de support plus de temps pour s'occuper de tâches plus complexes.
Comment utiliser le modèle Article de dépannage ?
Étape 1 : Décrivez le problème
Il est tentant de détailler directement la solution grâce à un article comme celui-ci, mais décrire le problème est une partie vraiment importante de la rédaction d'un contenu efficace. Les lecteurs doivent pouvoir dire si votre article traite des problèmes qu'ils rencontrent. Pensez à la façon dont votre public vit ce problème, et expliquez-le à l'aide d'une terminologie et d'exemples pertinents pour ces expériences.
Étape 2 : Fournissez une solution pas-à-pas
Une fois que vous avez décrit le problème, il est temps d'expliquer comment le résoudre. À l'aide d'une liste numérotée, rédigez une solution étape par étape. Utilisez des termes que les lecteurs connaîtront et comprendront, et passez en revue une étape à la fois. Dans la mesure du possible, illustrez les étapes à l'aide d'images. Ainsi, les personnes qui lisent votre article sauront à quoi doivent ressembler les choses à chaque étape du processus. S'il y a plusieurs solutions possibles, le mieux est de vous en tenir à la plus courante dans votre article. Si vous pensez vraiment qu'il faut donner plus d'options aux gens, vous pouvez utiliser une extension pour créer un panneau réductible, où d'autres solutions pourront être proposées.
Étape 3 : Affichez les articles connexes
Parfois, vous tombez sur un article qui traite d'un problème similaire au vôtre, mais pas tout à fait identique. Et parfois, en savoir plus sur le fonctionnement de quelque chose peut vous aider à prévenir les problèmes par la suite. En appliquant des étiquettes à vos articles de dépannage et en utilisant la macro « content-by-label » (déjà incluse dans ce modèle), vous pouvez afficher automatiquement les articles et les pages qui s'y rapportent. Veillez simplement à utiliser la même étiquette pour toutes les pages connexes.
Atlassian est un éditeur de logiciels professionnels qui crée des produits pour les développeurs, les chefs de projet et la gestion de contenu.
Plus de modèles Développement de logiciels/Informatique Tout afficher
-
Lucidchart
Diagramme d'architecture AWS
Visualisez votre infrastructure pour mieux identifier ses faiblesses et repérer les points à améliorer.
-
Atlassian
Concevez votre semaine de travail idéale
Fournissez des instructions pas-à-pas pour réaliser une tâche.
-
Atlassian
Runbook DevOps
Préparez votre équipe opérationnelle à réagir rapidement aux alertes et aux pannes système.