Разработка справочной системы

Question

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

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

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

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

Answer 1

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

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

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

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

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

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

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

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

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

Answer 2

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

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