Як створити покроковий гід для розв'язання проблем?

Перед початком

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

Кроки

1. Відкрийте Матеріали і виберіть Майстри неполадок. Відкриється список гідів.
2. Виберіть Нове.
3. Заповніть Заголовок. Необов'язково: Короткий зміст та Платформа, наприклад пристрій або застосунок, якого стосується проблема.
4. У полі tree введіть ваше дерево. Воно позначене як «advanced». Скористайтеся прикладом нижче.
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 символів, і починаються з літери або цифри. Кожен ідентифікатор використовується лише раз.
• Запитання має від 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. Звіртеся зі зразком.

Питання

Схоже

• Хаби довідки
• Способи зв'язку
• Статистика та підказки пошуку
• Довідковий центр і документація