Этапы проектирования справочной системы

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

Создание справки занимает достаточно много времени, так как через нее программист доносит до пользователя всю информацию по работе с программой. Процесс создания справки можно разделить на пять этапов.

Первый этап. Формирование понятного для пользователя справочного материала.

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

Использование графических элементов в справочной системе позволит пользователю легче сориентироваться в справочном материале и понять работу той или иной функции.

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

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

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

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

Второй этап. Создание разделов.

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

Третий этап. Создание перелинковки и ключевых слов материала.

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

Четвертый этап. Создание поискового механизма.

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

Пятый этап. Выбор оболочки.

Справка может быть создана в следующих форматах: doc (rtf), pdf, chm, hlp, exe, html и прочее. Не в каждом из этих форматов, например в таких как doc, pdf, можно реализовать четвертый этап проектирования справочной системы. Так как по работе с ними необходимо дополнительное программное обеспечение. Оболочку для справочной системы можно реализовать самостоятельно, это позволит пользователю не заморачиваться на поиске дополнительного программного обеспечения или использовать формат справки, который будет автоматически восприниматься операционной системой, например, такой как rtf, hlp, exe – для ОС Windows. Стоит обращать внимание, на тип вашего продукта, если реализованная программа является кроссплатформенной, то и справочная система должна быть тоже кроссплатформенной.

Компилирование справочной системы.

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

htm2chm  – программа позволяет преобразовывать как отдельные HTML страницы с рисунками, так и целые сайты (например скачанные offline браузерами) в один CHM файл (открывается стандартными средствами Windows) для того, чтобы их было удобней хранить. Конвертер автоматически сжимает файлы в процессе компиляции.

Help & Manual – позволяет создавать файлы различных help-форматов. Для удобства их создания в программу встроен WYSIWYG редактор. Все созданные проекты можно сохранить в форматах: HTML Help 1.x, Winhelp, Microsoft Help 2.0, Adobe PDF, e-Books, Browser-based help и т.д… Кроме этого, программа позволяет конвертировать help-файлы из одного формата в другой. Помимо программ для работы с текстом в Help & Manual включены утилиты для создания скриншотов и редактирования графических файлов.

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