Создание пользовательской документации к мобильному приложению: необходимость, способы, инструменты

Мобильные приложения вошли в нашу жизнь давно и надолго. Современному человеку уже сложно представить себя без смартфона или планшета, на котором установлен десяток-другой приложений. Поэтому разработка мобильных приложений является сегодня одной из самых востребованных услуг на IT-рынке.

Из множества вопросов, встающих перед мобильными разработчиками в процессе работы, в этой статье мы хотим остановиться лишь на одном - достаточно специфическом, но при этом очень важном: необходимо ли создавать пользовательскую документацию к мобильным приложениям?

Вероятно, ответ на этот вопрос зависит от многих факторов. Давайте рассмотрим их подробнее.

Мобильные приложения, не требующие пользовательской документации

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

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

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

Мобильные приложения, которым необходима пользовательская документация

Однако, многие мобильные решения все же тяжело назвать “приложением одной функции”. Многие из них требую предварительной настройки. Они также могут содержать несколько экранов, переключение пользователя между которыми может быть произвольным, а отнюдь не линейным. Поведение же программы или финальный результат могут зависеть от различных режимов работы и разных комбинаций пользовательских данных. Эти факторы значительно повышают сложность программы. Следовательно, пользователю может потребоваться гораздо больший объем вспомогательной информации по сравнению с той, которую можно отобразить в самом интерфейсе приложения или донести с помощью интерактивных подсказок.

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

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

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

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

Самый простой способ снабдить свое несложное мобильное приложение справкой - это встроить всплывающие по действию пользователя или по ситуации текстовые подсказки или экраны с короткими пояснениями прямо в приложение. Этот прием довольно часто используется разработчиками в “приложениях одной функции” или в несложных играх. Это удобно для пользователя, т.к. нет необходимости обращаться к внешней документации, покидая приложение. Однако, очевидный недостаток данного решения - невозможность удобной интеграции в мобильное приложение пользовательской документации объемом большим, чем несколько параграфов текста и десятка картинок. Кроме того, для того, чтобы внести изменения или правки в текст справки, встроенной в интерфейс приложения, придется изменить, обновить и перевыпустить само приложение. Это требует как дополнительных усилий со стороны разработчиков, так и времени на перевыпуск (релиз).

Для более сложных приложений с большим объемом справки требуются иные подходы.

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

Технически данный подход может быть реализован двумя основными способами, описанными ниже.

Предоставление пользовательской документации единым файлом в формате PDF - достаточно простой и универсальный способ. PDF файл можно написать практически в любом современном текстовом редакторе - от MS Word до Google Docs, а распространять его можно как с приложением, так и выкладывая на сайт проекта для загрузки.

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

Альтернативным способом является создание онлайн-руководства и публикации его на сайте продукта. Доступ пользователя к онлайн-справке осуществляется через любой интернет браузер, который есть в любом современном мобильном устройстве. Если каждый раздел онлайн-справки оформлен в виде отдельной HTML-страницы с уникальным URL, то разработчикам будет удобно реализовать контекстную справку в своем мобильном приложении. Например, можно встроить кнопку помощи в различные части программы. Эта кнопка будет открывать соответствующий раздел онлайн-справки в браузере. Обновлять же документацию, опубликованную на внешнем сайте, можно, не затрагивая код программы и не заставляя пользователей устанавливать обновления. Это значительно упрощает процесс управления пользовательской документацией и проектом в целом.

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

Инструменты создания пользовательской документации к мобильным проектам

В заключении отметим, что какой-бы способ создания и и обеспечения доступа к пользовательской документации из мобильного приложения вы не выбрали, вы без труда сможете реализовать его с использованием специализированных программ-инструментов. Например, отечественный программный продукт с мировым именем Dr.Explain позволяет создавать из единого источника руководства пользователя и файлы помощи в различных форматах: от PDF-руководств до онлайн-справок. Причем, онлайн-справки, созданные в этой программе полностью адаптированны для использования как на традиционных ПК, так и в браузерах мобильных устройств, что позволяет использовать их именно как системы помощи для пользователей мобильных приложений.

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