Что происходит с файлами справки в наши дни?

Question

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

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

ПОДОЖДИ!Ему нужен файл справки, чтобы пользователи могли обращаться к контекстно-зависимой справке из приложения!

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

Это то, что меня интересует, и это немного субъективно, поэтому вместо этого я собираюсь задать кое-что другое всем вам, кто разрабатывает настольные приложения: Предлагаете ли вы (по-прежнему) контекстно-зависимые файлы справки?

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

(Кстати, я сам перешел на неконтекстные PDF-файлы, которые можно распечатать вручную.Это намного проще в обслуживании.)

Answer 1

Да, я знаю.

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

Answer 2

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

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

Answer 3

В настоящее время мы этого не делаем, но мы пишем не так уж много приложений для Windows.Большинство из них основаны на Интернете.Большинство наших приложений для Windows довольно малы и хорошо документированы вне файла справки.

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

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

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

Answer 4

Никакой помощи?Это прекрасно для людей, которые разбираются в технике и любят поиграться с новым программным обеспечением.Но если вашим программным обеспечением будут пользоваться люди, не разбирающиеся в технике, помощь необходима.Возьмем ваш пример с датами.Если у вас международный рынок, вам лучше четко сформулировать, что нужно программе.Американцы используют формат ММ / ДД / ГГГГ, но большинство международных пользователей используют формат ДД / ММ / ГГГГ;вам нужно четко указать, что нужно программе.

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

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

Answer 5

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

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

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

Office и Visual Studio решили проблему довольно схоже - нажатие кнопки справка открывает страницу справки для всего диалогового окна, а не для отдельного элемента управления.

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

Answer 6

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

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

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

Answer 7

Все наши приложения имеют контекстно-зависимую справку в виде всплывающих подсказок (аналогично подсказкам Office 2007) по всем важнейшим функциям приложения.

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

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

Answer 8

Я высказываю вам личное мнение, не подкрепленное каким-либо другим фактом, кроме моего личного вкуса.

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

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

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

Answer 9

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

Мне кажется, что Microsoft вносит свой вклад в сокращение объема контекстно-зависимой справки, к лучшему это или к худшему.Во-первых, справочные системы в Visual Studio, мягко говоря, неудобны в использовании.Во-вторых, значительно снизилась простота использования справочной системы Visual Studio.Я опущу эту тираду, но достаточно сказать, что для этого требуется многие дополнительные клики и прокрутки для получения релевантной информации в справке VS2008.Это, как правило, устанавливает более низкие стандарты для справочных систем в приложениях.