Тип статті "Усунення несправностей" - найкращі практики

Статті "Усунення несправностей" відповідають на запитання "Як виправити...?", які виникають, коли користувачі стикаються з проблемами з нашими продуктами, послугами або функціями. Ці статті допоможуть користувачам виявити, діагностувати та вирішити поширені проблеми, надаючи чіткі та стислі рішення. На відміну від статей "Про" або "Як", які представляють або пояснюють, як користуватися пропозиціями Mozilla, статті "Виправлення неполадок" заглиблюються у вирішення конкретних проблем, гарантуючи, що користувачі зможуть повернутися до безперебійної роботи якнайшвидше.

Коли писати статтю "Усунення несправностей"

Подумайте про створення статті "Усунення несправностей", коли:

• Користувачі часто стикаються з певними проблемами, пов'язаними з продуктом, послугою чи функцією.
• Існує відома проблема, яку користувачі не можуть вирішити самостійно інтуїтивно.
• Оновлення, зміни або помилки створюють нові проблеми, з якими користувачам потрібна допомога.

Найкращі практики написання статей "Усунення несправностей"

• Визначте проблему: Почніть з чіткого формулювання проблеми. Це допоможе користувачам зрозуміти, що вони потрапили в потрібне місце і що стаття присвячена саме тому питанню, з яким вони стикаються.
• Поясніть причину: Якщо можливо, коротко поясніть, чому виникла проблема. Розуміння причини може допомогти користувачам запобігти виникненню подібних ситуацій у майбутньому.
• Надайте покрокові інструкції: Розбийте процес вирішення на чіткі, керовані кроки.

Структура статті

• Назва: Заголовок повинен відповідати тому, про що стаття, і тому, що шукає користувач. Назви статей про усунення несправностей повинні починатися з дієслова дії, але уникайте використання герундія. Також слід уникати заголовків статей, що містять слова "Як...". Намагайтеся використовувати ключові слова "Виправити" або "Вирішити" в заголовку і використовуйте заголовки в стилі речення для статей. Заголовки "Як це зробити" повинні бути орієнтовані на завдання, тоді як заголовки "Усунення несправностей" повинні бути орієнтовані на проблему. Обмежте свій заголовок приблизно до 60 символів, оскільки Google зазвичай відображає перші 50-60 символів тегу заголовка.
• Підсумок: У цьому розділі описано конкретні проблеми або симптоми, з якими можуть зіткнутися користувачі. Він повинен бути написаний чіткою і стислою мовою, уникаючи технічного жаргону, коли це можливо, щоб забезпечити його доступність для широкої аудиторії. Використовуйте такі ключові слова, як "не може", "не в змозі", "не працює", "збій" тощо, щоб допомогти в SEO.
• Основний вміст: Контент містить широту і глибину інформації, необхідної для діагностики та вирішення проблеми. Він також може містити результати та приклади. Додайте розділ "Зміст" на початку статті, якщо ви документуєте кілька наборів пов'язаних кроків. Використовуйте H2 для заголовків розділів. Перед документуванням кроків (наприклад, "Скиньте налаштування принтера Firefox") поставте перед собою мету.
  • Передумова: Це допомагає користувачам зрозуміти основні фактори, що сприяють виникненню проблеми. Додайте будь-яку інформацію або дії, які користувач повинен знати або виконати перед тим, як спробувати усунути проблему.
  • Контекст (за бажанням): Додайте будь-яку концептуальну інформацію або загальні причини, через які може виникнути проблема.
  • Кроки: Використовуйте впорядковані списки, щоб задокументувати кроки та дії, які необхідно виконати для діагностики та вирішення проблеми. Перш ніж документувати кроки, поставте перед собою мету. Уникайте використання вкладених кроків.
  • Результат (за бажанням): Додайте очікуваний результат після завершення набору кроків.
  • Приклад (за бажанням): Додайте будь-які приклади на підтримку завдання.
  • Пост-передумова (за бажанням): Додайте будь-яку інформацію, яку користувач повинен знати або зробити після виконання завдання.
• Дізнайтеся більше за посиланнями: Використовуйте H3 для заголовка розділу Дізнатися більше. Його не слід включати до змісту. Додавайте невпорядковані списки для посилань Дізнатися більше і не додавайте більше чотирьох посилань до цього розділу.

Приклади

• Виправлення проблем із друком у Firefox