ClickHelp

Материал из Викиреальностя
Перейти к: навигация, поиск
ClickHelp
Clickhelp's logo.png
Тип система для разработки технической документации
Разработчик ClickHelp LLC
ОС кроссплатформенное
Текущая версия 2018.01 — январь 2018
Лицензия
Сайт clickhelp.com

ClickHelp — это система для разработки технической документации, представленная в виде облачного web-приложения.

Содержание

[править] Функционал

ClickHelp — это облачное web-приложение. Работа с ним производится при помощи браузера. После покупки подписки пользователю предоставляется защищенный паролем онлайн портал для командной работы над технической документацией. Это подразумевает одновременный доступ в портал нескольких пользователей для работы над одним проектом, статусы, e-mail оповещения, историю изменений топика, откат топика к предыдущей версии без потери истории промежуточных изменений.

[править] Поддерживаемые форматы

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

Формат файлов Расширение файлов Импорт Экспорт
OpenDocument *.odt да да
Microsoft Open XML *.docx, *.doc да да
Другие текстовые документы *.rtf да да
Отсканированные документы и изображения *.pdf - да
HTML/XHTML/MHTML *.html, *.xhtml, *.html5, *.mht да да
HTMLHelp *.chm да да
Electronic Publication *.epub - да

[править] WYSIWYG редактор

ClickHelp's WYCWYG editor

Встроенный WYSIWYG редактор похож на Microsoft Word, OpenOffice Writer и, на текущий момент, построен на основе компонента редактора от DevExpress. Он позволяет форматировать текст, добавлять изображения и видео, вставлять гиперссылки. Также пользователям предоставляется доступ к исходному коду топика в формате HTML.

[править] Основной функционал продукта

Другие возможности продукта включают:

  • Управление контентом (HTML, CSS и JavaScript редактор, использование переменных и текстовых сниппетов, добавление медиа контента).
  • Поддержка технологии единого источника (условные блоки, сниппеты, переменные, условный вывод, условные стили, повторное использование контента (content reuse)).
  • Гибкий функционал (настройки поведения и стилей, брендинг, существующие интеграции и возможность добавления новых)
  • Патентованный движок полнотекстового поиска, оптимизированный для поиска по документации
  • Управление проектами (статусы готовности документов и настройка e-mail оповещений об их изменениях, роли пользователей, фильтр дерева содержания).
  • Функции рецензирования (специальные аккаунты рецензентов с ограниченными правами, добавление комментариев к фрагментам текста).
  • Статистика по опубликованной документации (количество просмотров топика, число позитивных и негативных отзывов согласно кликам по форме внизу страницы).
  • Статистика по проектам на стадии разработки (количество написанных слов по авторам, число топиков каждого статуса по ответственным, количество слов, добавленных в топик по датам и др.).
  • Возможность для читателей оставлять комментарии к топикам через интеграцию с сервисом Disqus.
  • Интеграция с Google Analytics.
  • Поддержка технологии единого входа для Google, Microsoft Azure, Salesforce и других OpenID провайдеров (заявлена поддержка спецификации OpenID Connect).
  • Настройка печатного формата документации (размер страниц, нумерация, поля и др.).

[править] Открытый API

ClickHelp предоставляет программный интерфейс (REST API) для автоматизации следующих операций:

  • Получение списка проектов.
  • Получение списка топиков в проекте или публикации.
  • Получение исходного HTML кода топика.
  • Создание пользователей и управление их данными.
  • Экспорт публикаций.
  • Доступ к отчётам.

Полная документация на ClickHelp API.

[править] Помощь и поддержка

В подписку включена техническая поддержка по email и через систему тикетов. Образовательные материалы включают:

— Документация пользователя[1]

— Краткие видео демонстрации[2]

— Платные удаленные тренинги

[править] Условия использования

При покупке подписки можно выбрать один из готовых планов[3] или настроить свой. Оплата подписки может быть ежемесячной или ежегодной.

[править] Примечания

[править] Ссылки

ClickHelp относится к теме «Программное обеспечение»   ±