Использование справочных материалов в Системе
Справочные материалы - это информация, которая предоставляет ответы на вопросы Пользователей при работе с Системой.
Общие рекомендации
- Использовать язык разметки Markdown;
- Максимально кратко и понятно описывать функции;
- При обращении к другому материалу обязательно добавлять ссылки на него;
- Добавлять скриншоты там, где это необходимо;
- Структурировать материал по функциям.
Основные функции справки
- Пошаговое описание всех необходимых для работы процессов;
- Ответы на часто задаваемые вопросы;
- Примеры выполнения задач.
Примеры реализации
Справка в сайдпейдже
При нажатию на кнопку Справка открывается сайдпейдж, который содержит детальную информацию о данной функции.
Отдельный документ
Необходимо использовать только если есть необходимость.
Во многих системах требуется «формальный» справочный документ. Для этого создаются PDF файлы, которые можно скачать нажав на кнопку в разделе Руководство пользователя.
Пример АИСОГД:
Кнопка перехода
Данная кнопка или индикатор может выглядеть по-разному. Вид определяется на основе информационной системы и экрана на котором находится.
Примеры:
Справка по кнопке в отдельных полях
Для показа справки по отдельным полям лучше всего использовать элемент сайдпейдж.
Для сложных полей с кодом или специальным синтаксисом нужны отдельные справочные страницы.
При нажатии на кнопку 
открывается отдельная страница, которая содержит справку со следующими элементами:
- Синтаксис;
- Вспомогательные функции;
- Модель данных;
- Пример шаблона.
Тултип
При наведении курсора на неподписанный элемент или иконку нужно показывать тултип.
