Наряду с традиционным подходом в разработке справочных систем часто используется сценарный подход. Он подразумевает построение контента вокруг типичных задач пользователя и делает руководство более практичным, понятным и ориентированным на реальные потребности.
Сценарный подход — это не просто методология написания, это философия взаимодействия с пользователем. Вот некоторые его преимущества:
- Доступность. Информация, представленная в контексте, запоминается и осваивается лучше.
- Применимость. Документация становится полезнее и эффективнее, так как напрямую отвечает на вопросы "Как мне это сделать?".
- Вовлеченность. Истории и сценарии могут быть более интересными и мотивирующими для изучения.
В этой статье мы рассмотрим пример справочной системы, разработанной в соответствии с этой методологией, отметим интересные находки и некоторые замечания к ее оформлению.
Cflow
Сервис Cflow — это платформа для автоматизации рабочих процессов. Ее база знаний описывает действия пользователя и состоит из ответов на вопросы о функциональности системы.
Ознакомиться со справочной базой Cflow можно по ссылке help.cflowapps.
Составить руководство из списка задач, которые возникают по мере использования сложного продукта, вполне разумно. Что сделали авторы для улучшения восприятия материала?
Базой знаний сервиса пользоваться удобно, шрифт приятный, но есть некоторые замечания.
Возможно, вопросы на определенную тему в правой панели стоит выделить цветом, соответствующим иконке: вопросы о работе с отчетами — красным, обзор платформы — фиолетовым и т.д. При этом уменьшив интенсивность цвета иконок и подсветки текста:
Данный пример показал, как может выглядеть справочное руководство, состоящее из вопросов и ответов: на главной странице сделан акцент на поисковой строке, чтобы пользователь сразу мог найти нужную информацию, а весь контент поделен на категории. Попробуйте применить сценарный подход в своей следующей пользовательской документации, возможно, в вашем случае он станет наиболее удобным способом объяснения сложного материала.