Как создать стабильную ссылку в продукте

Contributors Contributors Создано: 2 дня, 22 часа ago

Когда инженеры или менеджеры по продукту ссылаются на статью поддержки SUMO из продукта (например, Firefox), они всегда должны использовать стабильный URL, а не прямую ссылку на статью. Прямые ссылки меняются при обновлении заголовка или слага статьи, что может нарушить внутрипродуктовые ссылки. Стабильные ссылки защищают от этого и гарантируют, что пользователи всегда попадут на нужную страницу.

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

Почему важны стабильные ссылки

Использование прямых ссылок на статьи поддержки (например, https://support.mozilla.org/ru/kb/example-article) может привести к проблемам:

  • Они легко ломаются: URL-адреса статей меняются при изменении заголовка, если только редактор вручную не сохранит слаг.
  • Они не локализуемы: Прямые ссылки жёстко прописывают язык, что не идеально для международных пользователей.
  • Ими сложнее управлять: Мы не можем обновлять их глобально, если они используются непосредственно в продукте.

В отличие от них, стабильные ссылки:

  • Остаются постоянными, даже если URL статьи меняется
  • Автоматически определяют правильную локаль
  • При необходимости могут быть перенаправлены или обновлены централизованно

Формат ссылок для внутрипродуктовых статей поддержки

Используйте стандартизированный формат для создания стабильных ссылок на поддержку для настольных и мобильных продуктов:

Примечания:

  • %VERSION%, %OS% и %LOCALE% автоматически заполняются продуктом.
  • Поля <product> и <slug> создаются командой SUMO.
  • Замените <slug> на созданный вами уникальный слаг.

Этот формат гарантирует, что пользователи будут перенаправлены на правильную локализованную статью.

Пример:
https://support.mozilla.org/1/firefox/%VERSION%/%OS%/%LOCALE%/recommendations-firefox-new-tab

Как настроить стабильную внутрипродуктовую ссылку в Kitsune

Чтобы создать стабильное перенаправление, выполните следующие шаги в панели администратора Kitsune.

Вы должны быть администратором Kitsune с соответствующими разрешениями для создания стабильных ссылок.
  1. Войдите в панель администратора Kitsune.
  2. В разделе INPRODUCT нажмите Перенаправления.
  3. Нажмите Add Redirect в правом верхнем углу.
  4. Заполните обязательные поля Продукт, Тема и Цель, как описано в разделе Поля перенаправления ниже.
  5. Нажмите SAVE.
  6. Поделитесь готовой стабильной ссылкой с инженером или менеджером по продукту, используя внутрипродуктовый формат:
https://support.mozilla.org/1/firefox/%VERSION%/%OS%/%LOCALE%/<slug>

Поля перенаправления

Поле Описание
Продукт Используйте firefox для настольных компьютеров или mobile для мобильных продуктов Firefox.
Тема (слаг)

Введите короткий, уникальный идентификатор для статьи. Он станет частью стабильной ссылки.

  • Новая статья? Создайте новый слаг.
  • Существующая статья? Используйте текущий слаг статьи, если это уместно.
  • Используйте только строчные буквы (a–z) и дефисы (-)
  • Не используйте специальные символы, такие как #, подчёркивания или пробелы
  • Слаг должен быть простым и описательным, например: firefox-manage-account
Примечание: Слаг не должен совпадать с фактическим URL целевой статьи. Выберите что-то осмысленное и последовательное для использования в продукте.
Цель

Путь к статье поддержки, на которую вы хотите сделать перенаправление. Включайте только часть, начиная с kb/.

Пример: kb/firefox-lockwise-managing-account-data

Примечание: Вы можете включить якорь (например, kb/customize-items-on-firefox-new-tab-page#w_weather), чтобы сослаться на определённый раздел. Якоря работают только в английской версии и могут не работать в других локалях.

Советы

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

Эти прекрасные люди помогли написать эту статью:

Illustration of hands

Станьте волонтёром

Растите и делитесь опытом с другими. Отвечайте на вопросы и улучшайте нашу базу знаний.

Подробнее