Intereting Posts
Службы Kivy и Google Play Android Linkify – телефонные номера с возможностью кликов Android Studio java.lang.NoSuchMethodError с импортированной библиотекой Samsung Galaxy Tablet не позволяет вводить числа с плавающей запятой входы с типом «число» Как достичь свойства alignParentBottom = "true" в LinearLayout Как я могу воспроизводить видео MP4 по прямой ссылке в Android-плеерах Android? Могу ли я использовать glu с Android NDK Почему ActionbarSharelock показывает только значок переполнения, даже есть место Неверные типы ошибок Android: Object и int Android LocationListener Переключение с GPS на сеть Как получить «нижнюю» гравитацию, работающую над возможностью рисования в xml В приложении Google Play показано, как реализована панель ViewGroup, отображающая верхние списки приложений? Android: динамический переход класса модели для повторного обратного вызова Ошибка NavUtils.shouldUpRecreateTask на JellyBean Показывать изображение с заставкой с автоматической установкой

Как вы управляете пользовательской документацией для приложения для Android?

Исходя из мира настольных компьютеров Linux, я буду использовать для написания документации пользователя моего приложения как набора файлов markdown / docbook / любых файлов, создания соответствующих файлов HTML во время сборки и распространения их вместе с моим приложением для просмотра С каким-то средством просмотра справки, например, yelp , kchmviewer, Okular или подобным (мы говорим о приложениях на основе графического интерфейса, таких как Gnome и KDE, поэтому здесь не задействованы справочные и информационные страницы).

Android не предоставляет ничего подобного. Никакой официально поддерживаемый, предлагаемый / обязательный способ создания, управления и распространения документации конечного пользователя (AFAIK, по крайней мере). Нет инструментов для выполнения этой задачи (отложите в сторону веб-браузер и / или веб-просмотр).

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

Альтернативой, по-видимому, является:

  1. Поместите все свои вещи в каталог / asset или / res

  2. Покажите пользователю страницу index.html в веб-браузере по умолчанию (или внутри WebView, внутри диалогового окна) и оставьте его перемещаться по остальной части документа.

Кто-нибудь знает о более удобном (более организованном, лучше спроектированном) способе создания, управления и распространения пользовательской документации для приложения для Android?

И да: я знаю, что мобильные приложения обычно должны быть почти полностью самодокументированы (то есть: пользовательский интерфейс shoul ведет пользователя правильно, без какой-либо другой помощи). К сожалению, мы разрабатываем то, что требует некоторого количества предыдущего knwoledge, чтобы быть использованным.

Что-то вроде «витринного представления» может быть полезно для объяснения простых элементов пользовательского интерфейса. В GitHub есть довольно хорошая реализация: https://github.com/Espiandev/ShowcaseView

Эта библиотека будет создавать наложения для определенных элементов, и вы можете настроить ее для отображения только один раз, если хотите. Вот пример из документов:

Пример showcaseView

Я видел приложения (например, диспетчер задач Astrid на Android), которые содержат пошаговое руководство для пользователей, которые впервые используют приложение. Они отображают полупрозрачный оверлей поверх GUI. Этот оверлей содержит стрелки и комментарии, которые объясняют, что делают разные кнопки и ручки.

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