Рекомендации по созданию памяток
Памятки и составные памятки позволяют пользователю достигнуть цели, выполнив
последовательность шагов. В этих руководствах обсуждается применение памяток,
а также их создание.
Когда следует создавать памятки
Памятки хорошо подходят для задач, состоящих из нескольких шагов, выполнение которых приводит к ясному результату, например, к
построению простого приложения. Цель должна быть четко
определена, чтобы пользователь мог ясно увидеть результат после завершения
всех шагов памятки. Руководства являются хорошим примером памяток. Целью руководства
является изучение выполнения определенной задачи. Обычно памятки содержат
до 10 шагов, и их выполнение занимает примерно полчаса (или менее). Для более
крупных задач служат составные памятки.
Когда следует создавать составные памятки
Составные памятки применяются для руководства выполнением задачи, которая слишком
велика, чтобы ее можно было описать в одной памятке, либо которая содержит несколько
целей. Составную памятку можно использовать для описания последовательности задач,
каждая из которых основана на предшествующей задаче.
Когда не следует использовать памятки
Памятки следует использовать, если задача может быть решена путем выполнения
последовательности простых шагов. Памятки не подходят для справочной системы,
которая позволяет создавать HTML-страницы с большим количеством графических
объектов и случайным доступом к информации с использованием поиска и гиперссылок.
Памятки не предназначены для задач, требующих от пользователя ввода большого
объема текста.
Рекомендации по созданию памяток
- Используйте короткое и выразительное название.
- Где возможно, используйте в задачах памятки ссылки на справочную систему
с целью предоставления пояснений или более подробной информации.
- Рассмотрите возможность создания составной памятки, если она содержит более
10 шагов.
- Где возможно, используйте команды для выполнения простых объемных задач,
таких как открытие проекций, открытие ресурсов, выполнение мастеров. Также
следует предоставить описание достижения результата без использования команд.
- Убедитесь, что команды можно пропустить, если пользователь решит
выполнять шаги вручную.
- Укажите dialog="true" для шагов, открывающих диалоговые окна.
При этом памятка откроется в "блоке" справа от остальных окон.
- Организуйте шаги таким образом, чтобы пользователь часто видел отметки об
успешном выполнении шагов. Памятку, которая вносит ряд различных изменений в
исходный код на java и затем запускает приложение, можно написать таким образом,
чтобы это приложение запускалось после каждого изменения исходного кода.
- Убедитесь, что пользователю понятно назначение каждого шага.
- Вместо описания нескольких путей выполнения шага выберите самый
простой путь, требующий минимального описания.
- Используйте теги конца абзаца (<br/>) для улучшения читаемости.
- Для разбиения шага на более мелкие шаги можно использовать подэлементы.
- Подэлементы требуются не для всех памяток.
- Начинайте текст метки подэлемента со слова, означающего действие, например,
"Введите", "Разверните", "Выберите" и так далее
- Для меток подэлементов четко задайте текст интерфейса, используя кавычки,
чтобы пользователь мог отличить текст инструкции от текста интерфейса, с которым
он должен работать .
- Каждый подэлемент должен отвечать за одну простейшую задачу, например,
ввод одного значения.
- Всегда добавляйте элемент <onCompletion> к последнему шагу памятки.
- Протестируйте памятки для различных размеров панели памяток.
- При тестировании памяток откройте панель ошибок протокола, чтобы получать информацию о неполадках протокола.
Рекомендации по созданию составных памяток
- Составная памятка должна содержать задачи, связанные общей темой.
- Каждая задача в составной памятке должна иметь четко определенную цель.
- Для подтверждения успешного выполнения используйте элементы <onCompletion>.
- Имена задач должны быть короткими и выразительными.
- Сложные вопросы можно решить, используя задачи, основанные на предшествующих задачах.
- Используйте skip="true", если задача является необязательной.
- Для обеспечения согласованности убедитесь, что введение и имя простой памятки
соответствует введению и имени, указанным в составной памятке.
- В описаниях задач четко выделите текст интерфейса, используя форматирование
жирным шрифтом.
- Последовательности следует использовать только в том случае, если важен порядок
запуска задач.
Ссылки на связанную информацию
Работа с памятками
Работа с составными памятками
Простые памятки
Составные памятки