Лучшие практики по статьям типа "Инструкция"

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

Когда необходимо писать статьи "Инструкции"?

Рассмотрите написание статьи "Инструкция", когда вы:

• Рассказываете о новых функциях или продуктах: Всякий раз, когда мы запускаем новый продукт или внедряем какую-либо функцию, крайне важно предоставить пользователям представление о ее функциональности. Напишите практическую статью, которая поможет пользователям в настройке, использовании и оптимизации этих новых возможностей, гарантируя, что они смогут извлечь из них максимальную пользу с самого начала.
• Улучшаете пользовательский опыт для существующих функций: Если в нашем наборе продуктов есть функция, которую пользователи используют не в полной мере из-за сложности или недостатка знаний, это отличный вариант для статьи с практическими рекомендациями. Создайте подробные руководства, которые раскрывают весь потенциал этих функций, позволяя пользователям улучшить свой опыт и производительность.
• Решаете частые проблемы: Когда пользователи сталкиваются с повторяющимися проблемами или ошибками, статья "Инструкция" может стать спасательным кругом. Разрабатывайте статьи, в которых описываются эти проблемы с пошаговыми решениями, помогая пользователям решать проблемы самостоятельно. Сосредоточьтесь на том, чтобы разбить процесс решения на четкие, управляемые этапы, не забывая при этом устранять распространенные ошибки и вопросы.

Лучшие практики при написании статьи "Инструкция"

Создание эффективных статей "Инструкция" требует сочетания ясности, краткости и всесторонности. Вот как мы подходим к этому:

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

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

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

Примеры

• Удаление истории просмотра в Firefox для iOS