Скомпилированный файл HTML-справки
Беглый поиск по архивным дискам выявил весьма печальный факт: еще ни разу в жизни мне не приходилось долго и нудно писать справочную систему в полном объеме. Было много других работ - локализация объемных справок англоязычных программ, редактирование чужих отечественных справочных систем, дописывание материалов по новым версиям, переработка шаблонов и оболочек и т.д., но еще не представилась возможность написать справку от начала и до конца так, как это кажется правильным. Кроме того, при любых модификациях "чужих" справочных систем, на робкие предложения о полной переработке/переписывании руководители разного ранга обычно начинает махать руками и убеждать в том, что "нас это устраивает и лучше оставить всё как есть".
Именно этот безрадостный факт подвиг меня на создание своего рода шаблона, который должен продемонстрировать типовую структуру, дизайн, формулировки и состав "идеальной" (по крайней мере, в моем представлении) справочной системы.
Данный пример сделан в Help&Manual Pro v. 5, но его легко декомпилировать и преобразовать в шаблон для любой другой среды разработки справки (возможно, я и сам конвертирую этот пример в Adobe RoboHelp 7, если позволит время).
Буквально несколько фраз в качестве ответов на возможные вопросы:
- Контент полностью выдуман по ходу дела. Он не нарушает никаких авторских прав, не заимствован, не извлечен при декомпиляции и не связан ни с одной из существующих программ.
- При генерации файла CHM использован шаблон для веб-справки, но в HTML-проекте (стандартный трюк, популярный во многих программах, хотя и требующий тщательной проверки на совместимость с кодом программы для контекстно-зависимых справочных систем).
- Скрытие теста можно сегодня считать общепринятым методом, поддержка для которого у пользователей обеспечена полностью, равно как и для встраивания сценариев (скриптов) непосредственно в страницы справки.
- Я не разделяю мнение многих фанатиков концепции single source о полной идентичности справочной системы и руководства для пользователя. В справочной системе не нужны снимки экранов, поскольку страницы справки обычно открываются рядом с этими окнами. Но в руководстве пользователя (печатном или электронном) без снимков экрана не обойтись, но вставлять их следует не в справочную систему, а на этапе подготовки из нее руководства пользователя. Пока еще ни одна из сред разработки справочных систем не способна на разумное преобразование из CHM в PDF/DOC, поэтому нет никакого смысла в многократном увеличении объема справки за счет избыточных снимков экранов (screenshot) только для того, чтобы автор впоследствии не перепутал рисунки в руководстве пользователя.
- Исходный и выходной формат рисунков - PNG, отлично сохраняющий четкость даже очень мелких надписей. Преобразование в PNG на этапе компиляции справки пока еще неудовлетворительное. Хотя для фотографий лучше использовать JPG, а для мультипликационных (анимационных) картинок - GIF.
Загрузить и посмотреть файл CHM (архив ZIP, 77 КБ) >>>
|
