Лучшие практики для статей типа "О продукте"

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

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

Вам следует подумать о написании статьи "О продукте", когда:

• Вы представляете новый продукт, функцию или услугу.
• Необходимо объяснить концепцию или функцию, которые необходимы для понимания того, как эффективно использовать продукт.
• В существующем продукте, функции или услуге произошло значительное обновление или изменение, требующее нового объяснения.

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

• Знайте свою аудиторию: Имейте в виду, что статьи "О продукте" часто читают люди, которые, возможно, не знакомы с техническим жаргоном или тонкостями продуктов Mozilla. Старайтесь писать понятным, простым языком, доступным каждому.
• Начните с четкого определения: Начните свою статью с четкого, краткого определения продукта, функции или концепции, которые вы описываете. Избегайте использования технических терминов без пояснений.
• Объясните значение: После определения темы объясните, почему это важно. Какую пользу это приносит пользователю? Какую проблему решает? Для чего это было разработано?
• Предоставьте контекст: Помогите читателю понять, какое место занимает данный продукт, функция или сервис в экосистеме Mozilla.
• Используйте примеры: Примеры могут помочь прояснить сложные концепции. По возможности приводите практические примеры, иллюстрирующие использование предмета или его влияние.

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

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

Примеры

• Страница Новая вкладка в Firefox