Неотъемлемой частью любой информационной системы является справка пользователя, которая помогает начать работу и решить типовые задачи. Geometa не является исключением. Первая справка в этой системе появилась в 2020 году, когда был создан сайт, объединяющий ключевую документацию в одном месте и призванный дать ответы на вопросы о том, как создать карточку объекта, как начать оказание услуги, как отправить документ на согласование и другие. При создании справки специалисты Gems development преследовали цель помочь пользователю быстрее разобраться с системой.
Примерно год назад технические писатели компании провели большой опрос, чтобы понять, сохраняет ли справка пользователя актуальность, удобна ли она в эксплуатации или что-то необходимо изменить. Респонденты выразили недовольство системой навигации по страницам и неочевидным расположением статей «Новое в Системе».
Теперь компания готова представить обновленные сайты с документацией — всё ещё актуальнее и удобнее.
Итак, что изменилось в привычных интерфейсах?
1. Система навигации
В верхней и нижней частях страниц появились гиперссылки со стрелочками, которые позволяют переходить с одной страницы на другую.
2. Содержание страницы
Теперь справа можно увидеть панель со структурой документации, что позволяет быстрее искать необходимые разделы и параграфы и переключаться между ними, не покидая страницу.
3. Раздел «Новое в Системе»
Во-первых, этот раздел был перенесён и располагается теперь в блоке основных статей.
Во-вторых, изменена структура самих статей: теперь разделы представлены вкладками «Новое», «Исправление ошибок» для пользователей, и «Новое», «Изменения», «Исправление ошибок», «Метаданные» для интеграторов.
В-третьих, объединены все релизы по годам.
Все эти изменения помогут тратить меньше времени на поиск необходимой информации.
4. Интерактивные схемы
В разделе «Предоставление услуг» в схемах добавлены гиперссылки, которые позволяют узнать больше о необходимом этапе. Просто нажмите на название этапа и перейдите к соответствующему материалу.
5. Актуальная версия
В каждое руководство добавлена информация об актуальной версии Geometa, которую описывает приведённая документация.
6. Дизайн и тексты
Обновлены иллюстрации и цветовые решения руководств, добавлен логотип Geometa. Эти изменения были необходимы, чтобы каждый элемент оформления документации соответствовал брендбуку Geometa.
Справка пользователей стала более удобной для чтения, так как для тестов теперь используется шрифт Roboto. Такое типографическое решение поддерживается всеми операционными системами и не искажается даже при смене языка интерфейса.
7. Обратная связь
Gems development ценит мнение пользователей системы Geometa, ведь только совместная работа делает её лучше, именно поэтому в документацию добавлены формы обратной связи. На данный момент форма обратной связи имеется в шести проектах, но в планах компании расширить её применение.
Gems development благодарит заказчиков за комментарии к материалам, так вы помогаете улучшать документацию и поддерживаете авторов в их стремлении написать как можно лучше.