Лучшие практики в статьях типа "Устранение неполадок"

В статьях "Устранение неполадок" рассматриваются вопросы “Как мне устранить...?”, которые возникают, когда пользователи сталкиваются с проблемами при работе с нашими продуктами, услугами или функциями. Эти статьи помогают пользователям выявлять, диагностировать и устранять распространенные проблемы, предлагая четкие и лаконичные решения. В отличие от статей "О продукте" или "Инструкции", в которых рассказывается о том, как пользоваться предложениями Mozilla, статьи "Устранение неполадок" посвящены решению конкретных проблем, что позволяет пользователям как можно быстрее вернуться к нормальной работе.

Когда необходимо писать статью "Устранение неполадок"

Рассмотрите возможность создания статьи "Устранение неполадок", если:

• Пользователи часто сталкиваются с конкретной проблемой, связанной с продуктом, услугой или функцией.
• Существует известная проблема, которую пользователям может быть сложно решить самостоятельно.
• Обновление, изменение или ошибка создают новые проблемы, с которыми пользователям требуется помощь в навигации.

Лучшие практики по написанию статей "Устранение неполадок

• Определите проблему: Начните с четкого изложения проблемы. Это поможет пользователям понять, что они находятся в нужном месте и что в статье рассматривается проблема, с которой они столкнулись.
• Объясните причину: По возможности кратко объясните, почему возникает проблема. Понимание причины может помочь пользователям предотвратить повторение проблемы в будущем.
• Предоставьте пошаговые инструкции: Разбейте процесс урегулирования на четкие, выполнимые этапы.

Структура статьи

• Заголовок: Название должно соответствовать тому, о чем статья и что ищет пользователь. Названия статей по устранению неполадок должны начинаться с глагола действия, но избегайте использования деепричастий. Вам также следует избегать использования названий статей, содержащих слова “Как...”. Старайтесь использовать в названии ключевые слова “Исправить” или “Устранить неполадки”, а для статей используйте заглавные буквы в виде предложений. Заголовки “Инструкции” должны быть ориентированы на решение задач, в то время как заголовки “Устранение неполадок” должны быть ориентированы на решение проблем. Ограничьте размер заголовка примерно 60 символами, так как Google обычно отображает первые 50-60 символов тега заголовка.
• Резюме: В этом разделе описываются конкретные проблемы или симптомы, с которыми могут столкнуться пользователи. Он должен быть написан ясным и кратким языком, по возможности избегая технического жаргона, чтобы обеспечить доступность для широкой аудитории. Используйте такие ключевые слова, как “не могу”, “не удается”, “не работает”, “сбой” и т.д., чтобы помочь с SEO.
• Основное содержимое: Основная часть содержит обширную и подробную информацию, необходимую для диагностики и устранения проблемы. В ней также могут содержаться результаты и примеры. Добавьте раздел с оглавлением в начале статьи, если вы документируете несколько наборов связанных шагов. Используйте H2 для заголовков разделов. Определитесь с целью, прежде чем описывать шаги (например, “Сбросьте настройки принтера Firefox”).
  • Предварительные условия: Это помогает пользователям понять основные факторы, способствующие возникновению проблемы. Добавьте любую информацию или действия, которые пользователь должен знать или предпринять, прежде чем пытаться устранить проблему.
  • Контекст (необязательно): Добавьте любую концептуальную информацию или общие причины, по которым может возникнуть проблема.
  • Шаги: Используйте упорядоченные списки для документирования шагов и действий, которые необходимо предпринять для диагностики и устранения проблемы. Прежде чем документировать шаги, определите цель. Избегайте использования вложенных шагов.
  • Результат (необязательно): Добавьте ожидаемый результат после выполнения ряда шагов.
  • Пример (необязательно): Добавьте любые примеры, подтверждающие выполнение задачи.
  • Условия после выполнения (необязательно): Добавьте любую информацию, которую пользователь должен знать или сделать после выполнения задачи.
• Ссылки на дополнительную информацию: Используйте H3 для заголовка раздела "Дополнительная информация". Его не следует включать в оглавление. Добавьте неупорядоченные списки для ссылок "Дополнительная информация" и не добавляйте более четырех ссылок в этот раздел.

Примеры

• Исправление проблем с печатью в Firefox