Контекстная подсказка

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

Что это такое (терминологические вопросы)
Для чего это нужно (методические вопросы)
Как это сделать (технические вопросы)

Терминологические вопросы возникают при встрече пользователя с новым незнакомым термином или в случае непонимания текста, вызванного непривычным использованием терминологии. Исследования психологов показали, что в до 80% случаях непонимания текста, причина незнание или неверная интерпретация терминов, используемых в тексте. Поэтому, контекстную подсказку стоит снабдить глоссарием – списком используемой терминологии с пояснениями или определениями каждого термина.

Методические вопросы возникают тогда, когда пользователь не понимает: для чего предназначена данная программа и как с ее помощью можно решить его конкретную проблему. Чтобы быть понятной пользователю, методическая подсказка должна содержать теоретическую часть, доступно описывающую идею программы и методы, используемые в программе. Кроме этого, следует описать методики решения типовых задач с помощью данной программы. Пользователь далеко не всегда самостоятельно может понять причину своего непонимания. Поэтому хорошая подсказка должна иметь систему гиперссылок, постепенно отсылающих пользователя от конкретных вопросов, которые он не понимает, к все более общим вопросам методики.

Технические вопросы связаны с назначением конкретных органов управления (клавиш, кнопок, меню и т.д.), а также с рекомендациями (инструкциями) по выполнению конкретных действий. Подсказки по техническим вопросам ориентированы на оператора – человека, который непосредственно управляет программой.

К сожалению. Довольно часто программисты «забывают» написать методическую и терминологическую части подсказок. Если программа достаточно сложная и использует нетривиальные методы, отсутствие этих подсказок приводит к непониманию и множеству недоразумений при ее использовании. Примером хороших контекстных подсказок являются Help’ы к MS Office.

Ниже даны рекомендации по формированию контекстной подсказки. Принята следующая терминология:

Топик – раздел подсказки, посвященный одному вопросу. Топик имеет заголовок и идентификатор. Большинство современных средств программирования позволяют организовать контекстный вызов топика из определенного места программы (например, из окна).

Рабочий топик – посвящен техническим вопросам работы с конкретным окном программы.

Методический топик – посвящен вопросам теории и методики решения задач пользователя с помощью программы.

1. Общие рекомендации:

1.1. Текст топика не должен быть особенно длинным. Желательно, чтобы он помещался на одной странице справки (или незначительно превышал ее). Особенно это касается рабочих топиков. Для методических топиков размеры могут быть несколько больше.

1.2. Терминологические топики небольшого размера, в тексте которых нет гиперссылок, удобно вызывать как всплывающее окошко (Popup).

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

1.4. Содержание справки обычно формируется средствами генератора Help’ов. В структуре содержания желательно выделить теоретическую часть (основные понятия и используемые методы), глоссарий и рабочие топики.

1.5. При создании справки должен, по возможности, выдерживаться единый стиль. Цвета и размеры фона и шрифтов, оформление заголовков и гиперссылок, должны быть приятными и удобными для чтения. При выборе стиля желательно придерживаться фактического стандарта Windows. Различия в оформлении должны помогать ориентироваться в справочном файле. Например, рабочие, и методические топики могут отличаться каким-либо элементом стиля (цветом фона, формой заголовка или видом шрифта).

1.6. До каждого топика мы должны как-то добраться: он может быть вызван непосредственно из программы, указан в оглавлении или на него должна быть гиперссылка из других вызываемых топиков.

2. Требования к рабочим топикам. Эти топики должны вызываться контекстно из каждого экрана программы. Основные требования к ним:

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

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

2.3. Описание порядка работы. В рабочем топике должны присутствовать ответы на следующие вопросы:

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

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

2.3.3. Если необходимо вводить какие-то данные на экране, следует указать, откуда следует взять эти данные, и способ их введения. При необходимости указывается формат данных, или другие их характеристики.

2.3.4. Что в результате происходит при работе с этим экраном. На какие экраны происходит переход с этого экрана, в каких случаях. Для интерпретации получаемых результатов делаются гиперссылки на соответствующие методические топики.

3. Методические топики.Должны включать:

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

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

4. Терминологические топики.Кроме определений и пояснений в глоссарий желательно включить схемы и рисунки, иллюстрирующие взаимосвязи основных понятий. Сами определения желательно снабдить гиперссылками вида: «См. также…», отсылающими пользователя к определениям понятий, связанных с данным. Ссылками на термины, помещенные в глоссарий желательно снабдить все случаи использования данного термина в справочной системе.