Справка

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

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

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

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

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

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

Чтобы решить, рассмотрите следующие вопросы:

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

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

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

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

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

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

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

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

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

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

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

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

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

Попытайтесь изначально сделать помощь ненужной следующим образом:

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

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

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

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

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

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

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

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

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

Создание содержимого, которое имеет значение

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

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

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

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

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

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

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

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

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

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

Шаблоны использования

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

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

Руководящие принципы

Точки входа

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

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

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

  

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

  

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

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

  правильно:

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

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

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

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

  

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

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

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

  

  В этом примере аксессуар Windows Paint имеет категорию меню справки.

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

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

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

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

  

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

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

  

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

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

  

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

Содержание

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

Иконки

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

правильно:

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

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

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

Текст

ссылки на справочные материалы

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

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

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

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

  правильно:

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

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

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

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

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

  правильно:

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

  Как добавить исключения?

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

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

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

  

  правильно:

  

  Лучше:

  

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

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

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

  правильно:

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

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

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

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

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

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

  правильно:

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

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

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

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

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

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

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

  правильно:

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

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

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

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

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

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

справочная информация

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