Как и любая программа, HelpNDoc обладает рядом достоинств и недостатков. К неоспоримым достоинствам HelpNDoc можно отнести наличие бесплатной версии, возможность скрыть и удалить рекламные баннеры, документированный API, описание устройства шаблонов выходных документов в форматах CHM (HTML Help) и WebHelp и другие. Среди основных недостатков обычно выделяют отсутствие перевода пользовательского интерфейса на русский язык, а также документации на русском языке. В этой статье я расскажу, почему данные недостатки больше не актуальны.
Руководство пользователя HelpNDoc на русском языке существует. Это электронная книга «Разработка документации в HelpNDoc». В книге большая часть пользовательского интерфейса переведена на русский язык. Переводы приводятся в скобках после английского оригинала — разобраться сможет даже начинающий пользователь, владеющий английским языком на уровне выпускника средней школы.
Электронная книга «Разработка документации в HelpNDoc» оснащена динамическим оглавлением, предметным указателем и полнотекстовым поиском. В разделах с подзаголовками работает мини-оглавление. Окно электронной книги в Windows 7 выглядит следующим образом:
В книге «Разработка документации в HelpNDoc» вы найдете подробные инструкции на русском языке с иллюстрациями и примерами из практики. Прочитав книгу, вы сможете самостоятельно:
Установить и подготовить HelpNDoc к работе
- Как устроен пользовательский интерфейс HelpNDoc.
- Где искать файлы проектов, выходные документы, шаблоны.
- Как включить и настроить русский спелл-чекер.
- Как и где включить поддержку русского языка в проекте.
- Где и как перевести выходные документы на русский язык.
Спроектировать структуру документации
- Как добавить в проект разделы.
- Как организовать из них структуру оглавления.
- Как и для чего использовать свойства разделов.
- Как структурировать информацию в разделах.
- Как обеспечить работу полнотекстового поиска.
Наполнить проект контентом
- Как создать стили для единообразного оформления контента.
- Как добавить текст, и как работать с текстом.
- Как вставить в текст рисунки, таблицы, формулы, видео, HTML-код, переменные и другие объекты.
- Как автоматически пронумеровать любые объекты.
- Как добавить ключевые слова и создать из них предметный указатель.
- Как организовать контент документа в единую информационную систему (7 видов ссылок и как их использовать).
Использовать принципы единого источника
- Как добавить в проект и для чего использовать документы и сниппеты.
- Как управлять выгрузкой контента из разделов проекта в выходные документы по видимости, статусу и тегу сборки.
- Как логически разметить контент с использованием тегов сборки.
Проверить качество документации
- Как быстро найти и исправить битые ссылки.
- Как быстро проверить идентификаторы разделов.
- Как найти разделы без ключевых слов и неиспользуемые ключевые слова.
- Как быстро найти и удалить объекты библиотеки, которые не используются.
Скрыть рекламные баннеры
- Как быстро скрыть рекламные баннеры в CHM и WebHelp.
- Как удалить рекламные баннеры во всех форматах и получить чистые выходные документы.
В книге предложена методика скрытия и удаления рекламных баннеров без использования стороннего ПО: патчей, кряков и т.п.
Собрать выходные документы
- Как собрать один документ в необходимом формате.
- Как собрать пакет документов в разных форматах.
- Как настроить пакетную сборку.
- Как проверить выходные документы.
- Какой локальный сервер использовать для тестирования WebHelp.
Настроить готовые и создать свои шаблоны документов
- Как пользоваться Редактором шаблонов.
- Как написать код шаблона (устройство шаблонов на низком уровне).
- Как использовать PHP в WebHelp.
В книге предусмотрен раздел с пользовательскими сценариями. В разделе перечислены основные задачи пользователей HelpNDoc и даны ссылки на разделы с подробными инструкциями. Чтобы подробнее ознакомиться с описанием и содержанием книги «Разработка документации в HelpNDoc», перейдите по этой ссылке:
Электронная книга «Разработка документации в HelpNDoc» - подробная инструкция на русском языке
Чтобы задать любые вопросы по книге, используйте форму обратной связи в нижней части страницы.
Бесплатные видеоинструкции: HelpNDoc - Быстрый старт
Прямая ссылка на плей-лист: https://www.youtube.com/playlist?list=PLJtQLrKxe7uAEK7djn-BH96j0CSPNLQDK