Перейти к основному содержимому

Ссылки на справку в продукте

Zeno CY использует стабильные идентификаторы help_key, чтобы связывать элементы интерфейса и сообщения об ошибках с этим сайтом документации. Когда вы кликаете на иконку ? рядом с полем или читаете ошибку, ссылка знает, какую страницу и какой якорь открыть.

Как это работает​

  1. Вы кликаете ? рядом с полем или ошибка показывает ссылку на справку.
  2. Продукт разрешает help_key в URL документации с якорем секции.
  3. Страница документации открывается прямо на нужной секции.

Поскольку маппинг стабилен, ссылки можно сохранять, делиться ими и цитировать в письмах в поддержку, не боясь, что они «протухнут».

Что в приложении связано со справкой​

Ссылки на справку чаще всего прикреплены к:

  • шагам выбора папки и согласия коннектора,
  • ошибкам обработки и переразбора,
  • неокончательным статусам НДС,
  • действиям с отказом в правах,
  • ограничениям при требовании оплаты.

Если ссылка открывает не ту секцию​

  1. Скопируйте полный URL из новой вкладки.
  2. Пришлите его мне напрямую с коротким описанием, что вы делали.
  3. Включите request_id, если сообщение об ошибке его показывает — это сильно упрощает трассировку на моей стороне.

См. также​