Даже если Вы будете буквально следовать всем наставлениям документации Google по разработке приложений, все равно нет никакой гарантии, что пользователь сможет без проблем освоить Ваше приложение и быстро научится им пользоваться. К сожалению, так не бывает почти никогда.
Некоторые из Ваших пользователей обязательно столкнутся с вопросами или проблемами. Пользователи будут искать ответа в Вашем приложении, и если быстро не найдут ответ, то уйдут и никогда не вернутся.
Эта страничка рассматривает некоторые шаблоны и методы разработки для того, чтобы сделать доступным help в Вашем приложении. Здесь приведены советы по созданию содержимого help для пользователей, которые нуждаются в помощи (перевод документации [1]).
[Не показывайте незапрашиваемую справку, за исключением ограниченных случаев]
Естественно, что Вы хотите, чтобы все быстро и досконально узнали и обнаружили все замечательные функции Вашего приложения, вытащили их на свет и начали использовать. Так что Вы можете захотеть предоставить вводное слайд-шоу, видео или экран-заставку для всех новых пользователей, когда они первый раз откроют приложение. Или у Вас может появиться идея отобразить полезные текстовые хинты и пузыри с текстом, или диалоги, которые будут взаимодействовать с пользователем и рассказывать ему о разных функциях.
Видеоурок об использовании СПО «Справки БК»
Почти всегда так лучше не делать по следующим причинам:
• Агрессивные подсказки отрывают пользователя. Люди будут стремится начать использовать Ваше приложение или что-то, что Вы помещаете перед ними, и натыкаясь на неожиданную подсказку будут чувствовать её как препятствие и возможно будут раздражаться — несмотря на все Ваши благие намерения. И поскольку пользователи не просили подсказки, они наверняка не обратят должное внимание на неё.
• Агрессивные подсказки обычно не нужны. Если иногда сложно использовать приложение, то значит интерфейс разработан неудачно. Попытайтесь исправить это, пересмотрев UI. Если Вы будете применять стандартные шаблоны разработки Android, стили оформления и традиционное кодирование, то это сократит потребности в дополнительном обучении Ваших пользователей.
 |
| Сначала каждый пользователь попадает на экран всех приложений, где в ответ на каждый жест появляется полупрозрачная картинка подсказки |
Есть только одна причина отобразить полную подсказку для новых пользователей: чтобы обучить повышенной функциональности, которая доступна только с помощью использования интерфейса жестов.
К примеру, мы используем содержимое help, чтобы обучить пользователя, как разместить приложение на домашнем экране Android (Home screen). Эта функциональность заключается в следующем:
• Важное значение функции: без знания этой функции пользователи не смогут организовать для себя главный экран системы (который они видят чаще всего) так, чтобы он максимально удовлетворял из потребностям.
Как поменять рукописную дату на документах в фотошопе
• Доступность только через жесты: поскольку отсутствует специальная кнопка или меню для запуска функции, то пользователи могли бы никогда не обнаружить её.
Однако не все важные функции, работающие только от жестов, нуждаются в обучающем руководстве. Например, не учите пользователей, как делать прокрутку содержимого списка. Они и так будут знать это, поскольку это фундаментальный принцип взаимодействия, широко встречающийся в системе.
[Следуйте стандартам разработки для размещения справки]
На каждом экране Вашего приложения предоставьте возможность получения справки. Это можно сделать в Action Bar и в контекстном меню. Всегда делайте пункт вызова справки последним элементом в меню и пометьте его текстом «Help» («Справка»).
 |
 |
| Даже если у Вашего экрана нет никаких других пунктов контекстного меню, пункт справки «Help» должен находиться именно здесь, и его не нужно выносить в строку статуса программы (action bar). |
Пользователь не должен тратить много времени на поиск справки. Нужно, чтобы всегда соблюдался основной принцип дизайна: «Приемы работы с интерфейсом должны всегда и везде быть одинаковыми».
[Считайте каждую просьбу о помощи срочной и важной задачей]
В дополнение к справке, Вы можете захотеть предоставить другую информацию, такую как информацию о копирайте, разработчиках, правилах обслуживания, политике частного использования.
Позвольте пользователям получить эту информацию через пункт меню Справки (Help menu), но оптимизируйте поток людей со срочными вопросами о том, как делать что-либо, или почему что-то случилось с Вашим приложением. Меньшее подмножество пользователей, которые ищут юридические подробности или имена людей-разработчиков, не будут обременены некоторыми дополнительными шагами для получения информации.
Когда кто-то выберет подсказку «Help»:
Создайте экран справки в своем приложении, и предоставьте другие опции в строке меню (action bar). Например, Вы могли бы позволить пользователям связываться с Вами через форму обратной связи или через специальную кнопку. Выпадающее меню (Action overflow) идеальное место для не справочной информации, которая редко нужна.
[Принципы написания содержимого справки, отображаемой на экране]
• Help должен быть частью интерфейса пользователя (UI)
Экранная подсказка является расширением UI Вашего приложения, но не описанием его. Все слова на экране, от ядра приложения до подсказки должны следовать единым принципам написания (см. Writing Style), чтобы сквозной опыт пользования системы был логичным и связным.
• Учитывайте каждый пиксел
Не нужно документировать каждую деталь в Вашем приложении, особенно очевидные вещи, которые понятны простым просмотром UI, или поведение, которое является стандартом для платформы. Текст подсказки должен предоставлять только ключевую дополнительную информацию, которая не помещается как описание на экране.
• Картинки часто эффективнее, чем слова
При описании ключевых элементов UI и предоставлении пошаговых инструкций рассмотрите возможность снабдить текст подсказки иконками, частями скриншотов, сносками и другими изображениями. Вам не нужно будет тратить много слов, чтобы объяснить, о чем идет речь, и пользователи быстрее проглотят информацию.
• Помоги мне пролистать, не читая
Люди не должны читать help от начала до конца, чтобы разобраться в проблеме. Они пытаются быстро просмотреть справку в поиске содержащих ответ данных. Сделайте этот поиск менее обременительным, применяя дружественное форматирование и разметку, наподобие полужирного шрифта для заголовков, маркированных и нумерованных списков, таблиц, отступов между параграфами. И если объем материала очень большой, делите его на отдельные части и экраны, чтобы сократить прокрутку.
• Направьте меня прямо к ответу на вопрос
Что может быть лучше, чем экран, который легко просмотреть, экран, который не нужно прокручивать, потому что ответ уже находится на нем? Рассмотрите возможность, чтобы каждый экран в Вашем приложении направлял к подсказке, которая относится только к этому экрану и ни к чему другому. Такой принцип называется контекстной подсказкой, и он является Святым Граалем для помощи пользователю. Если Вы выберите такой подход, то убедитесь, что у пользователя есть возможность добраться также и до остального содержимого справки.
[Ссылки]
1. Designing Help into Your App site:developer.android.com .
2. Как сделать Android-приложение быстрым и отзывчивым.
Источник: microsin.net
Как писать справку для программы
16.07.2014
Создавать документацию для обычных пользователей даже сложнее, чем для технических специалистов, потому что неизвестно, какого уровня знаний и умений от них ожидать. Сегодня мы вместе с вами попробуем если не научиться этому, то хотя бы сделать первые шаги к овладению подобным умением.
Вы руководитель проекта по разработке софта и хотите получить всю документацию к нему без лишних забот? Наши специалисты с удовольствием сделают для Вас эту работу! Подробнее на этой странице: Разработка технической документации на аутсорсинге.
Или Вы технический писатель и желаете повысить свою квалификацию? Тогда — добро пожаловать на наш курс «Разработка технических текстов и документации».
Метод 2 из 2: Пишем документацию для конечных пользователей
- Определите бизнес-основания для документации. Хотя функциональная причина для документирования программного обеспечения в том, чтобы помочь пользователям понять, как использовать приложение, есть и другие причины, как например, оказание помощи при продвижении программного обеспечения, повышение имиджа компании, и, прежде всего, сокращение затрат на техническую поддержку. В некоторых случаях документация необходима, чтобы соблюсти определенные правила или иные правовые требования.
При этом ни в коем случае документация не должна быть компенсацией за плохой дизайн интерфейса. Если для объяснения экрана приложения нужны пачки документов, лучше сделать экран более интуитивным.
- Понимайте, для какой аудитории вы пишете документацию. В большинстве случаев пользователи программного обеспечения мало знают о компьютерах вне задач приложения, которые они используют. Есть несколько способов определить, как удовлетворить их потребности в вашей документации.
- Посмотрите на названия должностей ваших потенциальных пользователей. Системный администратор, скорее всего, специалист во многих программных приложениях, в то время как оператору ПК, скорее всего, знакомо только приложение, которым он или она в настоящее время пользуется для ввода данных.
- Посмотрите на самих пользователей. Хотя названия должностей в целом показывают, что именно эти люди делают, могут быть значительные различия в том, чем люди с одинаковыми должностями занимаются в разных организациях. Путём опроса потенциальных пользователей вы сможете понять, являются ли ваши мысли о том, что представляет из себя конкретная должность, правильными.
- Посмотрите на существующую документацию. Документация для предыдущих версий программного обеспечения, а также функциональных спецификаций, даёт некоторое представление о том, что пользователю нужно будет знать, чтобы использовать программу. Однако, имейте в виду, что конечным пользователям не так интересно то, как работает программа, как то, что она может для них делать.
Определите задачи, необходимые для выполнения работы, и задачи, которые нужно выполнить до выполнения этих задач.
- Определите подходящий формат(ы) для документации. Документация к программному обеспечению может быть создана в 1 из 2 форматов – справочном руководстве и руководстве пользователя. Иногда сочетание форматов является лучшим подходом.
- Формат справочного руководства посвящён объяснению индивидуальных особенностей программного приложения (кнопки, вкладки, поля и диалоговые окна) и тому, как они работают. Многие файлы справки написаны в этом формате, в частности контекстно-зависимая справка, которая отображает соответствующую тему всякий раз, когда пользователь нажимает кнопку Справка на конкретном экране.
- Формат руководства пользователя объясняет, как использовать программное обеспечение для выполнения конкретной задачи. Инструкции часто бывают в формате печатных руководств или PDF-файлов, хотя некоторые файлы справки включают темы о том, как выполнять конкретные задачи. (Эти разделы справки, как правило, не контекстно-зависимы, хотя на них могут ссылаться контекстно-зависимые разделы). Инструкции часто принимают форму учебного пособия с кратким изложением решаемых задач во введении и инструкциями в виде пронумерованных шагов.
- Решите, какую форму (ы) примет документация. Документация по программному обеспечению для конечных пользователей может быть в одной или нескольких из большого количества форматов: печатные руководства, PDF-документы, файлы справки или интерактивная справка. Каждая форма призвана показать пользователю, как использовать любую функции программы, будь то в виде пошагового руководства или учебного пособия; в случае с файлами справки и онлайн-справки наряду с текстом и простой графикой может включаться видео.
- Файлы справки и онлайн-справка должны быть проиндексированы с возможностью поиска по ключевым словам, чтобы пользователи могли быстро найти информацию, которую они ищут. Хотя авторские инструменты для справки могут генерировать индекс автоматически, зачастую лучше создавать его вручную, используя термины, которые, скорее всего, будет искать пользователь.
- Выберите соответствующий инструмент документирования. Печатные документы и руководства в формате PDF можно создавать с помощью программы обработки текстов, как Word, или сложного текстового редактора, например, FrameMaker, в зависимости от их длины и сложности. Файлы справки можно писать с помощью инструментов написания справки, таких как RoboHelp, Help and Manual, Doc-To-Help, Flare, HelpLogix или HelpServer.
Источник: protext.su
Получение справки в Visual Studio
Система Visual Studio — это весьма сложная среда для разработки программ, охватывающая множество языков программирования и основанная на широком использовании библиотек и компонентов. Практически невозможно знать все тонкости работы интегрированной среды разработки, владеть всеми языками программирования и даже полностью освоить технологию .NET Framework. По мере развития технологии .NET Framework и системы Visual Studio удерживать в памяти всю информацию о новшествах становилось все труднее; более того, на самом деле разработчикам чаще требуется знать только часть этой информации. Разумеется, у пользователей периодически будет возникать необходимость получить более полную информацию по конкретному вопросу. Для того чтобы помочь им в этих ситуациях, система Visual Studio 2013 предлагает обширную документацию в виде библиотеки MSDN Library Visual Studio 2013 Edition.
Разработчик имеет в своем распоряжении широкий спектр технологий. Они не только очень быстро развиваются, но и вынуждают программистов постоянно овладевать новыми знаниями. Поскольку все обо всем знать невозможно, разработчик должен непрерывно учиться. Часто знание того, как найти информацию о той или иной технологии, является таким же важным, как и способность ее освоить.
К счастью, существует множество информационных источников, содержащих информацию об этих технологиях. Включение в интегрированные среды разработки технологии автоматического дополнения IntelliSense, произошедшее около десяти лет назад, стало одним из важнейших обстоятельств, облегчивших работу разработчиков, но этот инструмент не может полностью заменить полноценную справочную систему, содержащую подробную информацию. Чтобы решить эту задачу, в среду Visual Studio включена справочная система для разработчиков.
Проще всего получить справку в среде Visual Studio 2013, использовав тот же метод, что и в любом другом Windows-приложении — нажав универсальную клавишу . Среда Visual Studio 2013 имеет свою фирменную справочную систему, использующую технологию Microsoft Help 3. Вместо использования специальной «оболочки» и предоставления пользователю средств навигации по ней справочная система теперь открывает окно браузера. Для доступа к более сложным возможностям справочной системы, например возможностям поиска (при работе в автономном режиме), существует специальное приложение «слушатель» (listener), выполняющееся в области системных уведомлений и обслуживающее запросы пользователей. Как в интерактивном, так и в автономном режиме справочная система и выглядит, и работает почти одинаково.
Иногда справочная система возвращает сообщение Service Unavailable. Возможная причина этой ошибки заключается в том, что «слушатель» справочной системы больше не выполняется в области системных уведомлений. Просто откройте справочную систему, находясь в среде Visual Studio, и «слушатель» будет автоматически запущен вновь.
Справочная система в среде Visual Studio является контекстно-зависимой. Это означает, что если курсор в настоящий момент расположен в определении класса в проекте и пользователь нажал клавишу , то в окне справки моментально откроется мини-учебник о текущей инструкции и способах ее использования:
Это невероятно полезное свойство, поскольку в этом случае вы быстрее получите необходимую информацию, чем если просто нажмете клавишу и станете искать нужное описание, листая справочную систему. Однако в некоторых ситуациях следует перейти сразу к содержанию справочной системы. Среда Visual Studio 2013 позволяет сделать это с помощью команды View Help меню Help.
Кроме использования справочной системы, пользователь также может зайти на форумы MSDN и сообщить о проблеме.
Навигация и поиск в справочной системе
Навигация по справочной системе очень напоминает перемещение по веб. В левой части окна браузера содержатся ссылки на страницы, принадлежащие тому же разделу справочной системы, что и страница, просматриваемая в данный момент, а также несколько ссылок, связанных с текущей страницей.
В правом верхнем углу окна браузера имеется окно для ввода поискового запроса, который вводится точно так же, как и в любой поисковой системе, например Google или Bing. Поиск является полнотекстовым и распространяется на все страницы справочной системы, причем запрос не обязательно должен содержаться в заголовках страниц. В итоге пользователь получит результаты, аналогичные результатам, которые он мог бы получить с помощью любой поисковой машины. В окне выводится по одной строке о каждом результате, чтобы можно было найти требуемый. Чтобы прочитать нужную статью, следует щелкнуть на соответствующей строке.
Конфигурирование справочной системы
Когда пользователь впервые обращается к справочной системе, целесообразно настроить ее под свои нужды. Для этого можно выбрать команду Help —> Set Help Preferences. Всплывающее меню предлагает два варианта: интерактивный (Use Online Help) или автономный режим работы (Launch in Helper Viewer). Если пользователь выбирает интерактивный режим, то нажатие клавиши или открытие справки из меню Help автоматически приведет его на соответствующую страницу в документации MSDN, расположенной в Интернете (с учетом текущего контекста системы Visual Studio). Выбирая автономный режим, пользователь попадет на соответствующую страницу в документации, установленной локально (при условии, что она действительно была развернута на данном компьютере).
Преимущество интерактивного режима над автономным заключается в том, что он всегда предоставляет обновленную информацию и не требует затрат памяти на жестком диске пользователя (при условии, что он не разворачивал справочную систему локально). Недостатком является необходимость постоянно поддерживать активное соединение с Интернетом и временами более медленная работа (в зависимости от ширины полосы пропускания), чем в автономном режиме. По существу, это компромисс, на который пользователь должен пойти самостоятельно.
Итак, новая справочная система представляет собой мощный интерфейс, обеспечивающий доступ к документации, сопровождающей пакет инсталляции Visual Studio 2013. Возможность переключаться между автономным и интерактивным режимами позволяет устанавливать баланс между скоростью поиска информации в локальной документации и релевантностью информации, найденной в веб. Кроме того, для каждого результата поиска она показывает один абзац, независимо от его расположения, чтобы минимизировать количество ложно позитивных результатов.
Источник: professorweb.ru