Как создать пошаговый траблшутер с вопросами и решениями?

Перед началом

• Вам нужны права на управление центром помощи.
• Сначала напишите статьи с решениями. Шаг с решением может ссылаться на одну из них.
• Дерево вводится в поле для опытных пользователей как текст в формате JSON. Не спешите и скопируйте пример ниже.

Инструкция

1. Откройте Материалы и выберите Мастера устранения неполадок. Откроется список траблшутеров.
2. Выберите Новые.
3. Заполните Заголовок. Необязательно: Краткое описание и Платформа, например устройство или приложение, к которому относится проблема.
4. В поле tree введите ваше дерево. Оно помечено как «для опытных пользователей». Используйте пример ниже.
5. Если в поле появится сообщение «That is not valid JSON, so it was not applied.», проверьте, не пропущена ли запятая или кавычка.
6. Поместите запись в нужный раздел хаба, затем опубликуйте.

Структура дерева

У дерева есть start и список nodes. Существует три типа узлов:

• Вопрос содержит text и от 2 до 8 answers. У каждого ответа есть label и next, указывающий на другой узел.
• Исправить содержит text. Он также может содержать articleId, номер одной из ваших опубликованных статей, или https url.
• Контакты завершает путь на панели «Нужна помощь?».

{
  "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." }
  ]
}

Правила, которые сайт проверяет при сохранении

• От 1 до 50 узлов.
• Идентификаторы узлов содержат строчные буквы, цифры и дефисы, до 40 символов, и начинаются с буквы или цифры. Каждый id используется один раз.
• Вопрос содержит от 2 до 8 ответов, и каждый ответ указывает на существующий узел.
• До каждого узла можно добраться из start.
• Дерево не может зацикливаться. Если ответ ведет назад к предыдущему вопросу, вы увидите: «This troubleshooter loops back to an earlier step. Every path must end with a fix or contact step.».
• Размер дерева может составлять до 32 КБ.

Полезно знать

• У каждого опубликованного траблшутера есть своя страница на вашем сайте.
• Аналитика. Аналитика помощи показывает Чем завершилась помощь, чтобы вы видели, до каких решений доходят читатели.
• Решение с articleId ссылается на статью только до тех пор, пока эта статья опубликована.

Частые проблемы

• «This troubleshooter loops back to an earlier step.» Ответ указывает назад. Измените его next на узел с решением или контактами.
• Ошибка сохранения дерева. В ошибке указан fields.tree. В узле отсутствует часть, например text или корректный next. Сверьтесь с примером.

Вопросы

Похожие темы

• Хабы справки
• Способы связи
• Аналитика поиска и подсказки
• Центр помощи и документация