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

Question

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

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

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

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

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

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

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

Answer 1

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 как о формате оперативной доставки справки, а просто как о версии, которую клиенты могут распечатать и использовать в качестве печатной копии. А всплывающие подсказки действительно зависят от вашего веб-приложения, а не от инструмента для создания справки.