Créer un guide de dépannage étape par étape

Avant de commencer

• Vous devez avoir l'autorisation de gérer le centre d'aide.
• Rédigez d'abord vos articles de solution. Une étape de résolution peut renvoyer vers l'un d'eux.
• L'arbre se saisit dans un champ avancé, sous forme de texte au format JSON. Prenez votre temps et appuyez-vous sur l'exemple ci-dessous.

Étapes à suivre

1. Ouvrez Articles et choisissez Guides de dépannage. La liste des guides de dépannage s'affiche.
2. Choisissez Nouveau.
3. Renseignez Titre. Facultatif : Résumé et Plateforme, par exemple l'appareil ou l'application concernés par le problème.
4. Dans le champ tree, saisissez votre arbre. Il porte la mention « avancé ». Aidez-vous de l'exemple ci-dessous.
5. Si le champ indique « Ce JSON n'est pas valide, il n'a donc pas été appliqué. », vérifiez qu'il ne manque pas une virgule ou un guillemet.
6. Placez l'entrée dans la bonne section de votre hub, puis publiez.

La structure d'un arbre

Un arbre contient un start et une liste de nodes. Il existe trois types de nœuds :

• QUESTION contient text et entre 2 et 8 answers. Chaque réponse comprend un label et un next qui désigne un autre nœud.
• Corriger contient text. Il peut aussi contenir un articleId, à savoir le numéro de l'un de vos articles publiés, ou un url en https.
• CONTACT termine le parcours sur votre bloc « Besoin d'aide supplémentaire ? ».

{
  "start": "q1",
  "nodes": [
    { "id": "q1", "kind": "QUESTION", "text": "Do you remember your password?",
      "answers": [ { "label": "Yes", "next": "q2" }, { "label": "No", "next": "f-reset" } ] },
    { "id": "q2", "kind": "QUESTION", "text": "Is two-step sign-in on?",
      "answers": [ { "label": "Yes", "next": "f-code" }, { "label": "No", "next": "c1" } ] },
    { "id": "f-reset", "kind": "FIX", "text": "Reset your password from the sign-in page.", "articleId": 1007 },
    { "id": "f-code", "kind": "FIX", "text": "Check your phone's clock and use a backup code." },
    { "id": "c1", "kind": "CONTACT", "text": "We can help you personally." }
  ]
}

Règles vérifiées par le site lors de l'enregistrement

• De 1 à 50 nœuds.
• Les identifiants de nœuds utilisent des lettres minuscules, des chiffres et des tirets, jusqu'à 40 caractères, en commençant par une lettre ou un chiffre. Chaque identifiant est unique.
• Une question comporte de 2 à 8 réponses, et chaque réponse renvoie vers un nœud existant.
• Chaque nœud doit pouvoir être atteint depuis start.
• L'arbre ne peut pas boucler. Si une réponse renvoie à une question précédente, vous verrez : « Ce guide de dépannage boucle sur une étape précédente. Chaque parcours doit se terminer par une étape de solution ou de contact. »
• La taille de l'arbre peut atteindre jusqu'à 32 Ko.

Bon à savoir

• Chaque guide de dépannage publié a sa propre page sur votre site.
• Statistiques. Les statistiques d'aide affichent Fin des guides de dépannage, ce qui vous permet de voir quelles solutions vos lecteurs atteignent.
• Une solution avec un articleId ne crée un lien vers l'article que tant que celui-ci reste publié.

Problèmes fréquents

• « Ce guide de dépannage boucle sur une étape précédente. » Une réponse revient en arrière. Modifiez son next pour pointer vers un nœud de solution ou de contact.
• Une erreur d'enregistrement concernant l'arbre. Le message mentionne fields.tree. Il manque un élément à un nœud, comme text ou un next valide. Comparez votre saisie avec l'exemple.

Questions

Articles connexes

• Centres d'aide
• Options de contact
• Recherches et statistiques
• Centre d'aide et doc produit