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

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

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

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

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

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

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

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

person Kariem    schedule 16.06.2010    source источник
comment
Вы когда-нибудь придумывали решение? Мы планируем сделать что-то подобное.   -  person Beep beep    schedule 25.04.2011
comment
К сожалению, ничего, что можно было бы назвать приемлемым решением. Мы добавили собственную структуру инструкций поверх нашего приложения, потому что клиент уже использует эту структуру для других решений. Я бы не рекомендовал это никому, потому что это повышает стоимость обслуживания справочной системы.   -  person Kariem    schedule 03.05.2011


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

person Jeremy Griffith    schedule 16.02.2013
comment
Добро пожаловать в Stack Overflow! Спасибо, что опубликовали свой ответ! Обязательно внимательно прочитайте Часто задаваемые вопросы о саморекламе. Также обратите внимание, что требуется публиковать заявление об отказе от ответственности каждый раз, когда вы ссылаетесь на свой собственный сайт/продукт. - person Andrew Barber; 17.02.2013