Разработка справочной системы - PullRequest
2 голосов
/ 02 декабря 2011

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

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

Какие знания мне следует ожидать отпользователя иметь?Возможно, немного унизительно записывать в файл справки, что File -> Open Project закрывает текущий проект (если присутствует) и открывает существующий проект.

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

Ответы [ 2 ]

1 голос
/ 02 декабря 2011

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

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

Помимо контекстно-зависимой справки, можно также просмотреть справку через систему помощи.

CHM во многом напоминаетэлектронная книга с оглавлением (TOC), индексом и, при необходимости, поддержкой полнотекстового поиска.

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

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

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

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

Хорошая помощь использует все эти элементы.

0 голосов
/ 02 декабря 2011

Существует два основных типа помощи: справочная (т.е. что означает этот флажок?) И справочная (как мне достичь XYZ?).

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

...