Плагин документации, мануала, инструкции

Плагин документации, мануала, инструкции Плагины WordPress
Когда мы получаем шаблон сайта или скачиваем программу, и то и другое обычно сопровождается документацией с инструкцией по установке, настройке и использованию. Чтобы сделать аналогичное руководство, нам поможет плагин документации, мануала, инструкции.
Плагин документации, мануала, инструкции
В зависимости от выбранного плагина это может быть онлайн документ или индексный файл html с папками содержащими стили оформления, скрипты и изображения (дизайна мануала и контента).
Следует признать, что такой шаблон для онлайн документации очень удобен. Однако существует несколько плагинов документации, которые располагают дополнительным функционалом, делающим ознакомление с такого рода инструкциями еще более удобным.

Кому будет полезен плагин документации

Ответить на этот вопрос довольно легко, так как составление руководств и сопроводительной документации нужно практически каждому, кто занимается творчеством и разработками в сети Интернет.

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

Платные и бесплатные плагины документации

Ниже мы рассмотрим несколько плагинов WordPress, которые помогают создать структурированные инструкции и руководства. Увы, но среди них нет бесплатных. Поясню, почему. Дело в том, что на данный момент, среди найденных мной бесплатных плагинов документации, ни один не давал даже близкого результата, в сравнении с приведенным выше примером. А единственный подходящий среди бесплатных, позволял создавать только одну инструкцию и предлагал снять ограничение в PRO версии. (Поиск производился Июнь 2016.)

Плагин Docs Online Product Documentation WP Plugin самый популярный среди представленных в этом обзоре. У этого плагина и в самом деле не мало достоинств:

  1. Создание неограниченного числа документации;
  2. Возможность голосования (открытое или для отдельных групп);
  3. Авто-обновление боковой панели навигации на основе прокрутки позиции;
  4. Несколько вариантов оформления шаблона документации;
  5. Пользовательские CSS стили;
  6. Адаптивный дизайн;
  7. Плагин легко переводится на ваш язык;
  8. Возможность "взять" ссылку на любой пункт, раздел вашй документации
  9. и пр.

Плагин Documente - Help Documentation Builder в целом похож на предыдущий, однако в нем отсутствуют две удобные опции (3 и 8), зато есть (А) кнопка - отправить на печать и (Б) скачать архив с индексным файлом и файлами стилей и js скриптов, для последующего размещения в Интернет или может быть использовано в качестве сопроводительной документации. В данном случае жесткой привязки к Интернет - нет. То есть, для просмотра этого руководства вам не потребуется подключение к Интернет.

Список файлов архива созданных в Help Documentation Builder

Чем примечательна кнопка "на печать"

Если вы установите на компьютер бесплатный PDF конвертер из Doc и Html, то сможете, кроме уже имеющихся вариантов (онлайн и оффлайн) предложить своим клиентам вариант руководства в формате PDF. Процесс конвертирования, занимает всего несколько секунд.

Описание Documente - Help Documentation Builder

А еще в плагине Documente - Help Documentation Builder вы можете добавить информацию о создании руководства, версии, последней дате обновления, авторе, дать ссылку на контакты тех. поддержки и пр.

Плагин Easy Product Documentation Builder for WordPress имеет больше вариантов оформления документации. Прямо скажем, в плане дизайна инструкции создаваемые в этом плагине самые красивые. Однако в плане функциональности Easy Product Documentation Builder отстает от первых двух плагинов. При создании документации вы можете использовать Visual composer или другой Page Builder.

Выводы

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

Оцените статью
SEO продвижение
Добавить комментарий