Нужно ли включать короткую справку внутри программного продукта?

Категория: Технические советы

– Автор: Игорь (Администратор)

В данной статье я хотел бы поговорить о том, нужно ли включать короткую справку внутри программного продукта с точки зрения интерфейса, а не отдельного справочного документа. Можно ли однозначно ответить на этот вопрос, какие есть особенности, что необходимо учитывать и что дает эта документация.

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

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

Если же целевая аудитория разношерстная, то без подсказок, примеров и небольших текстовых вставок просто не обойтись. Суть тут проста, всегда приходится рассчитывать, что по кнопкам и мышке будет клацать новичок, которому очень лень читать даже одну страничку с инструкцией, ему нужно чтобы все было объяснено по мере необходимости. Ничего плохого в этом нет, ведь люди разные. Однако, это накладывает свои ограничения.

Другой вопрос в том, какое оптимальное соотношение документации и реальных инструментов (элементов управления). Однозначно ответить на этот вопрос попросту невозможно. Можно ограничиваться всплывающими подсказками или небольшими примерами внутри элементов управления. Что-то вроде "введите свое имя в формате Фамилия И.О.". Можно пойти дальше и снабдить интерфейс мини инструкциями и пояснениями к каким-то сложным или необратимым действиям. Вероятно, ни один раз видели фразы "Настоятельно рекомендуется сохранить резервную копию...".

В большинстве своем, количество и объемы зависят от уровня знаний пользователей и сложности операций. При чем ряд документации в интерфейсе может появляться только временно. К примеру, в игрушках часто бывают "ознакомительные туры", в веб-сайтах могут появляться небольшие окошки с информацией, которые, после подтверждения пользователем о прочтении, более не показываются. В данном случае лучше всего представить себя этим самым пользователей и спросить себя какая информация вам бы пригодилась на разных этапах использования вашего продукта. Как альтернативный вариант, перед выпуском продукта можно дать его неопытным, но любопытным и активным, пользователям, а затем внимательно послушать их вопросы и посмотреть результаты их деятельности.

Как бы то ни было, важно понимать, что справка внутри интерфейса дает весьма существенные плюсы:

1. Уменьшает количество ошибок, особенно сложно исправляемых. К примеру, некоторые неопытные пользователи смело перестраивают данные в таблицах БД, без какого-либо бэкапирования информации.

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

3. Знание о возможностях программного продукта. Когда программа включает в себя огромное количество функций, то обычно часть этих возможностей остается вне поля зрения пользователей (иногда и существенная часть). Простые описания, хоть даже в виде небольших тезисов, позволяют обратить внимание пользователей. Например, если у вас полнофункциональный комбайн с кучей функций, то даже список блюд может подтолкнуть пользователя к использованию всех функций, а не только взбивания сливок.

Есть и другие плюсы, но это, пожалуй, одни из основных. Теперь, вы знаете о вопросе документации внутри интерфейсов программных продуктов больше.