Шаровароварение: ингредиенты

Евгений "Firstborn" Рогов

Спецвыпуск: Хакер, номер #053, стр. 053-014-5

SOS, он же F1

Твои иконки находятся на стадии разработки, и настало время заняться справочной системой. Пожалуй, глупо отрицать эту необходимость на фоне того, что мы условились считать твоего клиента человеком, мало разбирающимся в чем бы там ни было. Но в то же время не менее глупо думать, что хоть какой-то заметный процент пользователей начнет работу с твоей программой с чтения Help'а (ты сам так хоть раз такое делал?). Так что твой Help почти обязательно должен быть ориентирован на контекстную помощь, то есть в каждом диалоговом окне твоей программы должна присутствовать кнопка Help, нажатие на которую (равно как и судорожное стучание по F1) должно отправлять пользователя в систему помощи, причем не на первую страницу с надписью "Спасибо, что приобрели наш продукт!", а в раздел, имеющий непосредственное отношение к тому окну, из которого была вызвана справка.

Существует один достаточно популярный метод написания справочной системы такого рода: когда сама программа будет почти готовой, то есть ее основные функции и интерфейс уже будут реализованы, просто пройдись по всем имеющимся в системе окнам и расставь на них кнопки вызова справочной системы. Теперь создавай help-файл, в котором каждой такой кнопке поставь в соответствие раздел, описывающий функцию, реализованную в соответствующем окне приложения. Лучше всего делать это в виде пошаговой инструкции в стиле How to... - так пользователь сможет быстро сориентироваться и понять, на каком шаге он на данный момент находится и что ему делать дальше. Желательно в каждый такой раздел добавить хотя бы по одному скриншоту, благо особые графические дарования тут не нужны, знай себе жми <Alt>+<PrtScr>. Дополнительного графического оформления, как правило, не требуется. Также постарайся ограничить число используемых шрифтов, их цветов и стилей одним или двумя, в противном случае твоя справка будет выглядеть весьма пестро и неудобоваримо. Если ты используешь формат справки, позволяющий создавать гипертекстовые ссылки (WinHelp или HTMLHelp, например), обязательно используй эту возможность: добавляй ссылки на другие разделы там, где пользователь по ходу чтения сможет наткнуться на незнакомое понятие, а также в конце раздела (See also - список разделов, каким-либо образом связанных с данным).

Что касается технической реализации справочной системы, тут нет ничего проще: существуют инструменты, позволяющие создавать файлы справки так же просто, как и документ в Word. Причем один проект можно будет впоследствии откомпилировать как в WinHelp, так и в HTMLHelp и другие форматы - по крайней мере это несложно сделать в моем любимом Help & Manual (www.ec-software.com/hmpage.htm). Ты же для себя наверняка найдешь инструмент по своему вкусу, благо сейчас их развелось множество как бесплатных, так и не совсем. Ну а формат, который ты решишь выбрать для своего файла справки, во многом предопределен: скорее всего, это будет WinHelp или HTMLHelp. Оба эти формата позволяют создавать справочные системы практически любой сложности, разрешают из одного раздела ссылаться на другой, вставлять картинки, использовать различное оформления текста, оба специально разработаны для создания справочных систем - чего же еще? В свою очередь, выбор между этими двумя есть скорее дело вкуса: HTMLHelp новее, моднее, немного шире по возможностям и держит все в одном файле, в то время как справочная система на основе WinHelp может наплодить до пяти файлов за счет полнотекстовых индексов и прочих прибамбасов. Зато, говорят, у старичка WinHelp'а поиск сделан грамотнее, но мне все равно как-то милее HTMLHelp! Хотя бы потому, что он не задает дурацких вопросов при первой попытке что-то поискать в нем.