Background
Возможности программы Dr.Explain
← Назад к обзору возможностей

Создание онлайн-руководств

Одним из самых популярных форматов пользовательской документации сейчас является онлайн-справка. В Dr.Explain вы можете сделать из своего проекта набор HTML страниц, которые сразу можно загрузить на сервер, тем самым создать готовое онлайн-руководство пользователя.

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

Кроме того, наличие онлайн-документации - это почти обязательный критерий для попадания в Реестр отечественного ПО, который дает немало преимуществ российским компаниям на внутреннем рынке.

Для того чтобы опубликовать онлайн-справку вам не нужны знания HTML или CSS. Dr.Explain все может сделать за вас. Создайте проект в главном меню программы и распишите разделы будущего онлайн руководства. Воспользуйтесь готовыми шаблонами руководств, если не хотите сами придумывать структуру документации.

Заполните разделы контентом - текстом и изображениями, описывающие функционал ПО. В этом вам поможет редактор Dr.Explain, а также его алгоритмы автоматического аннотирования.

Настройте стиль вашего руководства не выходя из программы. Вы можете воспользоваться как предустановленными темами программы, так и сделать свои, используя CSS. Также вы сможете настроить внешний вид онлайн руководства в режиме предпросмотра.

В web-руководстве должно быть оглавление, позволяющее быстро перемещаться по всему документу. Каждая страница руководства посвящена определенной теме и содержит ссылки на другие разделы. Кроме того, страницы содержат специальные навигационные ссылки: следующая страница, предыдущая страница, индексы и т.д.

Осталось только экспортировать вашу документацию и загрузить на сервер. Dr.Explain позаботится и об этих шагах.

Смотрите также