Справка

Примечание

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

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

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

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

Домашняя страница справки и поддержки Windows, доступная в меню "Пуск".

Примечание: Рекомендации, связанные со стилем и тоном , представлены в отдельной статье.

Это правильный пользовательский интерфейс?

Чтобы определиться, ответьте на вопросы:

• Насколько мотивированы ваши целевые пользователи? Чем более мотивированы они, чтобы обнаружить функциональность вашей программы и стать ее промежуточными или даже продвинутыми пользователями, тем больше они будут готовы изучить ответы на свои вопросы, проконсультировавшись с разделами справки.
• Вы используете справку для устранения проблем с пользовательским интерфейсом? Чем лучше ваш пользовательский интерфейс, тем меньше пользователей будут обращаться за дополнительной помощью. Если в вашей программе есть очень понятный и полезный основной пользовательский интерфейс (например, сообщения об ошибках без жаргона, хорошо написанные мастера и однозначные диалоговые окна), вам может не потребоваться дополнительная система справки.
• Ваша программа относительно проста? Если это так, рассмотрите возможность включения всего необходимого содержимого в основные области пользовательского интерфейса. Пользователи чаще обращаются за дополнительной помощью в программах, выполняющих сложные задачи.
• Предназначено ли ваше приложение для разработчиков, ИТ-специалистов или других экспертов по программному обеспечению? Эти пользователи, как правило, ожидают справочной справки по соглашениям о языке программирования и подробной концептуальной справки для овладения функциями.

Принципы проектирования

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

Служба поддержки Windows была разработана в соответствии с этими принципами. Ниже приведены некоторые изменения в пользовательском интерфейсе справки Windows.

• Дополнительные доступные для обнаружения точки входа в справку из основного пользовательского интерфейса (особенно новые ссылки справки из поверхностей пользовательского интерфейса, таких как диалоговые окна, сообщения об ошибках и мастеры). Ссылки на справку помогут вам перейти непосредственно к соответствующей теме справки.
• Значок кнопки Справка доступен в правом верхнем углу большинства панель управления центральных страниц, а также папок оболочки.
• Пользователи могут выбрать получение актуального содержимого справки из Справки и поддержки Windows Online, когда они подключены к Интернету.
• Разделы справки теперь основаны на задачах, а не на функциях, поэтому пользователи могут быстро и эффективно выполнять свои задачи.
• Разделы справки теперь в значительной степени основаны на известных сценариях с лучшими пользователями.
• Темы справки имеют более спокойный и неформальный тон, используя реальный язык.
• Разделы справки предназначены для эффективного сканирования, так как пользователи редко читают содержимое слово в слово.

Аналогия для справки

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

• Получите ориентацию; искать ориентиры, уличные знаки (названия и указатели на места).
• Найдите карты.
• Наконец, в крайнем случае, спросите о направлениях или позвоните другу.

Дизайн "интерфейса" города влияет на вашу потребность в помощи. Хорошо помеченные улицы, явные направления (указатели на больницы, аэропорты, музеи и почтовое отделение) и четкие ориентиры, такие как известные географические объекты или здания помогают вам найти свой путь.

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

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

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

Проектирование пользовательского интерфейса таким образом, чтобы справка была ненужной

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

• Упрощает обнаружение и выполнение распространенных задач.
• Предоставление четких main инструкций.
• Предоставление четких и кратких меток элементов управления, ориентированных на цели и задачи.
• Предоставление дополнительных инструкций и объяснений там, где это необходимо.
• Прогнозирование избежать проблем с помощью элементов управления, ограниченных допустимыми вариантами, предоставления подходящих значений по умолчанию, обработки всех форматов ввода и предотвращения ошибок.
• Написание сообщений об ошибках, которые предоставляют четкое решение или действие для пользователя.
• Избегайте запутанных проектов пользовательского интерфейса, таких как задачи с плохим потоком или использование элементов управления, которые отключены без видимой причины.
• Работа с авторами и редакторами в начале цикла разработки для создания высококачественного и согласованного текста пользовательского интерфейса во всей программе.

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

Учет мотивации пользователей

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

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

Написание содержимого для сканирования

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

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

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

Создание важного содержимого

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

Совет: Техническая поддержка — хороший источник содержимого справки. В службах технической поддержки часто хранятся записи часто задаваемых вопросов о конкретных программах или задачах, которые пользователи пытаются (и не могут) выполнить.

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

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

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

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

Написание привлекательного текста ссылки на справку

При создании ссылки на раздел справки из основного пользовательского интерфейса обязательно напишите привлекательный текст ссылки на справку. Четкий и конкретный язык внушает уверенность. Пользователи, как правило, считают, что универсальные ссылки на справку (кнопка со словом "Справка" или "Подробнее") не приведут к правильной информации без значительных затрат времени.

Если вы делаете только пять вещей...

1. Проектируйте пользовательский интерфейс так, чтобы пользователям не нужна помощь.
2. Сделайте свою справку полезной, сосредоточив внимание на основных вопросах в основных сценариях для целевых пользователей.
3. Представить содержимое справки, чтобы его было легко сканировать.
4. Поймите, что вам не нужно предоставлять справку по каждой функции в пользовательском интерфейсе.
5. Сделайте точки входа справки обнаруживаемыми и привлекательными.

Варианты использования

Различные виды содержимого служат разным целям.

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

Рекомендации

Точки входа

• Ссылка на конкретные соответствующие разделы справки. Не ссылайтесь на домашнюю страницу справки, оглавление, список результатов поиска или страницу, которая просто ссылается на другие страницы. Избегайте ссылок на страницы, структурированные как большой список часто задаваемых вопросов, так как это заставляет пользователей искать ту, которая соответствует ссылке, которую они щелкнули. Не ссылайтесь на конкретные разделы справки, которые не являются актуальными и полезными для задачи. Никогда не ссылайтесь на пустые страницы.

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

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

  

  В этом примере вторая ссылка на справку применяется к группе элементов управления.

  

  В этом примере ссылка справка применяется ко всему окну.

• По возможности используйте ссылки на справку вместо общих текстовых ссылок.

  Правильно:

  Как исправить ошибки диска?

  Неправильно:

  Дополнительные сведения об устранении ошибок диска см. в разделе Справка и поддержка.

• Используйте кнопку Справка со значком справки для центральных страниц элементов панели управления. Поместите его в правый верхний угол. Эти кнопки не имеют метки, но имеют подсказку со справкой.

  

  Элемент панели управления с кнопкой "Справка".

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

• Программы с строками меню могут иметь категорию меню "Справка". Рекомендации по меню справки см. в разделе Меню.

  

  В этом примере вспомогательное устройство Windows Paint содержит категорию меню "Справка".

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

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

• Не используйте следующие устаревшие стили точки входа справки: "Подробнее" или "Подробнее о..." ссылки, универсальные кнопки справки и контекстно-зависимые кнопки справки в заголовке окна. Хотя они использовались в прошлом, исследования удобства использования показали, что пользователи, как правило, игнорируют их. Вместо этого используйте ссылки на определенные разделы справки. Рекомендации по написанию хороших ссылок на справку см. в разделе Ссылки на справку.

  Неправильно:

  

  Не используйте "Подробнее" или "Подробнее о..." Ссылки.

  Неправильно:

  

  Не используйте универсальные кнопки справки.

  Неправильно:

  

  Не используйте контекстно-зависимые кнопки справки в заголовке окна.

Содержимое

• Не создавайте очевидное содержимое. Разделы справки, которые повторяют то, что находится в основном пользовательском интерфейсе, не добавляют ценности.
• Не создавайте содержимое, с которым пользователь не может действовать каким-то образом.
  • Исключение: Некоторые концептуальные материалы предоставляют важную справочную информацию, не обязательно приводя к действиям пользователя.
• Избегайте расплывчатых решений проблем. Например, "обратитесь к системному администратору" или "переустановите приложение", как правило, разочаровывает пользователей.
  • Исключение: Рекомендуется обратиться к системному администратору, если это единственное практическое решение, и системные администраторы ожидают, что они будут обращаться за этой проблемой.
• Избегайте содержимого, которое предназначено для маловероятных пользовательских сценариев. Разработайте содержимое справки main для ожидаемого использования. Обратите внимание на важные исключения из ожидаемого использования, но рассматривайте это содержимое как более низкий приоритет.
• Соберите отзывы пользователей о том, насколько полезны ваши разделы справки. Разрешить пользователям оценивать отдельные темы. Проведите исследование удобства использования документации, чтобы выявить проблемы, связанные с качеством и доступностью содержимого.
  • Совет: Отзывы пользователей — это также отличный способ создать больше содержимого на основе задач, ориентированных на то, что пользователи на самом деле делают с вашей программой, в отличие от содержимого на основе функций, сосредоточенного просто на описании технологии.
• Предоставьте несколько способов доступа к содержимому. Оглавление, индекс и механизм поиска — это три наиболее распространенных метода повышения возможности обнаружения.
• Если существует несколько способов выполнения задачи, в большинстве случаев можно просто задокументировать наиболее распространенный способ, используемый неопытными пользователями.

Значки

• Используйте значок справки только для Обозреватель окон и центральных страниц элементов панели управления. Не используйте значок справки со ссылками справки.

Правильно:

В этом примере в окне Windows Обозреватель используется значок справки для предоставления доступа к справке.

Неправильно:

В этом примере значок справки в левом нижнем крае неправильно используется со ссылкой на справку.

Текст

Ссылки на справку

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

  • Исключение: Вы можете использовать "Дополнительные сведения" для дополнения инструкций, которые находятся непосредственно в пользовательском интерфейсе, особенно если предоставление определенных сведений в ссылке "Справка" приводит к ненужному повторению или делает ссылку менее привлекательной.

  Неправильно:

  Надежный пароль содержит не менее шести букв, цифр и символов в смешанном регистре. Что такое надежный пароль?

  Правильно:

  Надежный пароль содержит не менее шести букв, цифр и символов в смешанном регистре. Дополнительные сведения

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

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

  Неправильно:

  Дополнительные сведения о добавлении исключений

  Правильно:

  Каковы риски, связанные с разрешением исключений?

  Разделы справки добавить исключения?

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

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

  Неправильно:

  

  Правильно:

  

  Лучше:

  

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

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

• Используйте всю ссылку на справку для текста ссылки, а не только ключевых слов.

  Правильно:

  Каковы риски, связанные с разрешением исключений?

  Неправильно:

  Каковы риски, связанные с разрешением исключений?

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

  • Исключение: Ссылки справки на внешние веб-сайты должны просто использовать имя сайта или страницы в качестве ссылки. Любой текст, содержащий название сайта, не должен включаться в саму ссылку.

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

  Правильно:

  Как повысить производительность этой функции? (текст ссылки)

  Настройка этой функции для обеспечения оптимальной производительности (заголовок раздела)

  Неправильно:

  Как повысить производительность этой функции? (текст ссылки)

  Полный обзор этой функции (заголовок раздела)

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

• Если содержимое справки находится в Интернете, укажите это в тексте ссылки. Это помогает сделать результат ссылок предсказуемым.

  Правильно:

  Дополнительные форматы и средства см. на веб-сайте Майкрософт.

  Неправильно:

  Где можно найти дополнительные форматы и средства?

• Используйте полные предложения.

• Не используйте знаки препинания, за исключением вопросительных знаков.

• Не используйте многоточие для ссылок или команд справки.

Содержимое справки

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