Обзор внутренней документации

Функция поддержки внутренней документации позволяет добавлять собственные документы (в виде текста или URL-ссылок) в существующую интерактивную справку.

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

Внутреннюю документацию можно создать на панели внутренней документации в модуле Администратор. Дополнительные сведения см. в разделе Панель "Внутренняя документация".

Пример.

Иван — администратор Release Control в организации ABC. Веб-администратор Светлана сообщает Ивану, что каждый понедельник она будет проводить обслуживание веб-сайта и просит его создать в Release Control категорию периода времени, которая будет ограничивать доступ для внесения изменений на веб-сайте компании по понедельникам.

Иван создает категорию периода времени с именем Web_blackout. Когда пользователи Release Control откроют модуль "Анализ" и перейдут на вкладку Оценка > Конфликты периода времени, они могут обнаружить, что их запланированное изменение конфликтует с периодом времени Web_blackout. Иван ищет способ объяснить пользователям, почему существует эта категория периода времени, и решает написать внутреннюю документацию.

Он переходит на панель внутренней документации (Модуль > Администратор > Конфигурация > Внутренняя документация), выбирает параметр Конфликты периода времени на панели Область продукта и создает документацию, заполняя необходимые поля и сохраняя изменения.

Когда пользователи откроют модуль "Анализ", перейдут на вкладку Оценка > Конфликты периода времени и нажмут кнопку Справка (), появится ссылка на документацию Ивана, в которой объясняется новый период времени.

При нажатии ссылки откроется новое окно с содержимым, которое подготовил Иван. Вместо того чтобы добавлять текст на панели внутренней документации, Иван может также задокументировать период времени на внутреннем веб-сайте компании и вставить ссылку. В этом случае при нажатии ссылки откроется соответствующий URL-адрес.

Обращайтесь