Расширяемая структура для контекстно-зависимой помощи в веб-приложении - PullRequest
Новая
       20

Расширяемая структура для контекстно-зависимой помощи в веб-приложении

4 голосов
/ 16 июня 2010

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

Мы планировали использовать DITA в качестве системы документации иСейчас мы думаем о простом и расширяемом способе позволить разработчикам указывать элементы, которые предоставляют контекстно-зависимую помощь и могут быть заполнены техническими авторами и инструкторами.

На основе DITA мы хотели бы создать руководство пользователя в PDFи контекстно-зависимая справка, интегрированная в веб-приложение на основе JSP.Какие у вас есть рекомендации?

Мы уже находимся в процессе оценки коммерческого приложения, имеющего следующие функции

  • инструмент авторинга для идентификации элементов на веб-странице, которая будет заполнятьсяс справочной информацией
  • интеграция с системами управления обучением
  • поддержка приложений, не основанных на веб-технологиях

Есть ли у вас какие-либо базовые рекомендации?В дополнение к вышесказанному, было бы здорово:

  • интегрировать с DITA (любым возможным способом)
  • контент, относящийся к группе пользователей (пользователь извлекается из веб-приложения)
  • можно использовать из простого веб-приложения для отображения (html) подсказок
  • связи контекста справки со следующей иерархией: application> page> element (HTML id?)

1 Ответ

1 голос
/ 17 февраля 2013

DITA - это архитектура документов, а не инструмент.Таким образом, это не ограничивает ваш выбор в качестве инструмента для разработки или для создания PDF и интерактивной справки из вашего источника DITA.Непонятно, какую интерактивную справку вы имеете в виду, но звучит так, будто вам нужны HTML-страницы, которые могут отображаться самим приложением, а не трипан, например CHM.

Существует несколько инструментов, которыегенерировать свои выходы из DITA.DITA-OT (Open Toolkit) - это инструмент FOSS на Sourceforge, который может создавать XSL-FO, из которого вы можете создавать PDF, а также HTML, CHM и некоторые другие.Тогда есть бесплатная DITA2Go http://dita2go.com, которая делает Word RTF для производства PDF, а также HTML и несколько форм интерактивной справки;он использует атрибут ID темы как часть (или все, если хотите) имен файлов HTML.Кроме того, существуют коммерческие программы, хотя и не приносящие большого преимущества по сравнению с DITA2Go.

Лучше не думать о PDF как о интерактивном формате доставки справки, а только как о версии, которую клиенты могут распечататьи использовать в качестве печатной копии.А всплывающие подсказки действительно важны для вашего веб-приложения, а не для создания справки.

...