Какое дело со справочными файлами в эти дни? - PullRequest
6 голосов
/ 16 сентября 2009

Я добавил этот вопрос в SuperUser для перспективы пользователя.

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

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

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

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

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

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

Ответы [ 9 ]

4 голосов
/ 16 сентября 2009

Да, я делаю.

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

3 голосов
/ 16 сентября 2009

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

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

2 голосов
/ 17 февраля 2011

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

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

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

2 голосов
/ 16 сентября 2009

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

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

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

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

1 голос
/ 17 сентября 2009

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

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

1 голос
/ 16 сентября 2009

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

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

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

1 голос
/ 16 сентября 2009

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

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

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

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

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

1 голос
/ 16 сентября 2009

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

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

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

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

1 голос
/ 16 сентября 2009

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

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

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

...