Форум Сообщества Аналитиков
Дисциплины => Обучение => Тема начата: p_safin от 19 Февраля 2013, 15:17:17
-
Коллеги, доброго времени суток.
Хотел бы поговорить о технологиях и инструментах реализации справочных систем. Можно, конечно, отправлять заказчику руководство пользователя в виде документа pdf, doc и т.п. Этот вариант работоспособен для небольших систем.
Но мне всегда была интересна реализация справочных систем на основе веб-технологий. Яркий пример, который мне очень понравился: https://my.eset.com/help/ru-RU/index.html.
Вопрос:
— Как сделать нечто аналогичное? Что для этого потребуется?
-
Что потребуется:
Знание ПО
Умением писать понятные тексты
Владение HTML
Как сделать:
Разработать перечень тем для справки, опираясь на требования к ПО, статистику обращений в поддержку
Приоритизировать темы по важности
Написать тексты, начиная с самых важных
Снабдить тексты инструментом обратной связи о из качестве
Дать инструмент для задавания вопросов
-
Денис, спасибо за ответ.
Насчет "как" — все понятно. А вот насчет "что потребуется": не мог бы ты уточнить, с помощью какого ПО можно сделать справочную систему, подобную той, что упомянута в 1 сообщении? Интересует техническая часть вопроса.
-
Денис, спасибо за ответ.
Насчет "как" — все понятно. А вот насчет "что потребуется": не мог бы ты уточнить, с помощью какого ПО можно сделать справочную систему, подобную той, что упомянута в 1 сообщении? Интересует техническая часть вопроса.
Ответ по технической части вопроса: смотри helpandmanual.com
В исходниках js (helpman_navigation.js) прописано, откуда они взялись (EC Software).
-
artvish, спасибо. Буду разбираться.
-
На прошлой работе пользовался Macrobject Help Authoring Suite.
Стоит недорого, экономит кучу времени. Написав один документ в MS Word, получаем PDF-руководство и chm-справку. По идее это разные документы, но ради экономии, на мой взгляд, подойдет один документ на обе роли.
Умеет генерировать chm и/или html, в зависимости от конфигурации программы, подробнее здесь: http://www.macrobject.com/products.htm (http://www.macrobject.com/products.htm).
-
cosmoline, спасибо.
-
http://forum.philosoft.ru/cgi-bin/forum/ikonboard.cgi
---------------
И соответственно:
* AuthorIT - очень хорошо стоит
* Robohelp - хорошо стоит
* WebHelp
* DocBook
* DITA
* и понеслось.
Может быть даже http://ru.wikipedia.org/wiki/Altova но это вряд ли.
-
* AuthorIT - очень хорошо стоит
* Robohelp - хорошо стоит
Это сложные пакеты для разработки доки. Основная их идея - разработка доки в специализированных редакторах, а затем импорт в PDF, CHM, HTML.
Macrobject Help Authoring Suite (бывший Word-2-CHM) работает как простой конвертор:
1. разрабатываем в Word обычную доку, используем заголовки, перекрестные ссылки, картинки вставляем как обычно, без сохранения отдельно на диске.
2. запускаем конвертор, который из doc файла сделает chm и/или html, при этом сгенерируется файл с номерами топиков (топики соответствуют заголовкам в word), которые прописываются в коде для вызова справки в нужном месте.
PS. Покупали через софтлайн, за сумму 50-100$, точно не помню.
-
А вот интересно - что используют большие правильные продуктовые компании (Каспер, Абби и т.д.) для управления хелпа по продуктам?
Наверняка вся дока хранится в одном месте, привязана к продуктам и релизам, написал один хелп по инсталляции ко всем продуктам, нажал кнопку и вся дока для всех продуктов нужных релизов сгенерилась - мечтаю )
-
У таких контор другая проблема - мультиязычная справка и ее обновление при каждом релизе.
Я вот заметил такую тенденцию - чем больше пользователей продукта и если они разговаривают на разных языках, тем скуднее справка. Смотрю chm-справку отечественной CAD-системы - все расписано достаточно подробно, много скринов и примеров (хотя в этом случае много не бывает). Смотрю on-line справку импортной аналогичной системы (объемы продаж отличаются на порядки) - написано мало, ни одного лишнего слова, скриншотов нет (еще бы, иначе их придется обновлять в каждом релизе). Или они минимизируют затраты на документирование, либо таким образом кормят своих дилеров.
PS. Наверное по этим же причинам не очень распространена справка в виде видеороликов.
-
Большие системы действительно дополнительно зарабатывают на обучении.
-
Интересная тема.
Действительно у большого многофункционального продукта с динамичным выпуском релизов с изменением интерфейсов проблема поддержания справки и других справочных и учебных артефактов превращается в серьезную проблему.
Наверное потому ряд таких продуктов очень часто имеют довольно статичный во времени интерфейс, взять ту же линейку от AllFusion CA. Да и EA тоже не больно активно меняет внешнее представление.
-
На самом деле в каждом релизе интерфейс хоть чуть-чуть, но меняется.
В тулбар вставили новую иконку и все, скрин не актуален.
Мы вообще, поначалу, из-за неопытности в заголовке формы вставляли версию продукта, что означало переделку всех картинок.
Но даже без заголовка формы в новом релизе (выходит обычно раз в год) писателем переделывается 80-90% скринов.
Сейчас глянул справку EA, наобум смотрю раздел "Create Project Scenario". Полных скринов формы нет, только часть меню с командой "New Project". Вообще побегав бегло по разделам справки EA, скринов формы вообще не нашел. Диаграмм много, кусочки меню есть, но полных картинок нет. Тертые ребята, минимизируют издержки.
-
Насколько я помню по работе в ЛК, пользы от справки было не очень много.
Её наличие сейчас во многих продуктах — скорее атавизм.
-
Насколько я помню по работе в ЛК, пользы от справки было не очень много.
Её наличие сейчас во многих продуктах — скорее атавизм.
Согласен, мало народу реально пользуется справкой
-
Это если система относительно простая.
В сложном инженерном ПО ради выполнения определенной задачи требуется определенная последовательность действий. Интуитивно понятный интерфейс здесь не спасет. Нужно обучение или чтение справки.
-
И тут я тоже скажу, что сложных инженерных систем меньше, чем простых.
Поэтому и «во многих продуктах».
-
А вот интересно - что используют большие правильные продуктовые компании (Каспер, Абби и т.д.) для управления хелпа по продуктам?
Наверняка вся дока хранится в одном месте, привязана к продуктам и релизам, написал один хелп по инсталляции ко всем продуктам, нажал кнопку и вся дока для всех продуктов нужных релизов сгенерилась - мечтаю )
Каспер использует AuthorIT.
Но "Нажал кнопку и вся дока сгенерилась" - это несбыточная мечта документатора, также как и "Нажал кнопку и вся система скомпилировалась, собралась и заработала" - мечта девелопера :)