[CASE] Автоматизация рутинных операций в Dr.Explain помогает компании IPICA быстрее обновлять пользовательскую документацию
Максим Шумейко, основатель и директор компании IPICA Ltd, рассказывает о том как наличие хорошей документации к программному продукту влияет на все аспекты бизнеса, и как Dr.Explain волшебным образом позволяет создавать такую документацию без лишних усилий и затрат.
DE: Какие продукты разрабатывает ваша компания?
Основным продуктом нашей компании IPICA Ltd является программа для проектирования систем систем видеонаблюдения IP Video System Design Tool (www.jvsg.com). Это достаточно сложная профессиональная программа, которая помогает быстро и оптимально расположить камеры видеонаблюдения на существующем или созданном с нуля плане местности, определить зоны обзора и слепые зоны с учетом препятствий. В итоге заказчику предоставляется проект системы видеонаблюдения, учитывающий особенности охраняемого объекта и снабженный результатами трехмерного моделирования.
DE: Почему для вас важна документация?
Есть две части этого ответа. Я даже затрудняюсь сказать, какой из факторов более важен для нас.
Первое. Документация это обязательный элемент. Его ожидают. Люди знают, что справочная система должна быть в продукте, особенно в таком сложном, как наш. Так же как и техподдержка. Если есть техподдержка, должна быть и документация. Они тесно связаны.
У самого продукта интерфейс довольно насыщенный и пользователям зачастую хочется почитать о нем подробнее. Иногда пользователям достаточно хелп-файла в формате CHM, а иногда - готового к печати PDF-файла. Нередко даже при наличии файла-справки пользователи просят: “А пришлите нам еще и PDF.” Поэтому с определенного момента мы стали включать и его в дистрибутив программы.
Второе. Для нас на самом деле очень важно, чтобы люди знали какие функции в программе есть и как ими пользоваться. Для нас это хорошо. Когда люди используют все возможности программы, они получают более профессиональный результат и за это больше любят нас и наш продукт. Бывало так, что мы добавляли новую функцию в программу, а люди ей не пользовались. Они просто не знали о ней, потому что не щелкнули правой кнопкой мыши и не вызвали контекстное меню, где была эта функция. Документация решает и эту проблему.
DE: Документация в продукте была с первых версий? Как вы ее писали?
Да. Документация у нас была с первых версий продукта. Писать ее начали в программе HelpNDoc. На тот момент я знал еще о существовании продукта Help&Manual, но он показался дорогим, и мы остановились на более бюджетном варианте.
Со временем пришли к тому, что документацию предоставляем в трех видах. Первое - это традиционный help-файл к приложению. Затем, PDF-файл. Он также есть в дистрибутиве, чтобы люди могли распечатать и почитать. Как я уже говорил, некоторые пользователи любят так делать. И третий вид - это онлайн-справка на сайте. Сейчас мы уделяем ей все больше и больше внимания.
Она хороша и тем, что кто-то читает ее прямо на сайте самостоятельно, и тем, что при ответе на вопросы в техническую поддержку легко давать ссылочку на отдельный раздел онлайн документации, чтобы в письме детально не объяснять и не расписывать, что и как можно сделать в конкретной ситуации, например установить настройки какой-то конкретной камеры. Достаточно просто дать ссылку на страницу в хелпе, где все это детально описано. Во-первых, это ускоряет ответы на вопросы, а во-вторых, мы показываем пользователю, что у программы есть справка и приучаем его пользоваться справочной системой, а не писать нам письма. Это разгружает техподдержку.
Кроме того, пользователи старых версий, читая актуальную онлайн-справку, видят, что существует новая версия программы, и видят, какие дополнительные функции в ней есть. Это их дополнительно мотивирует приобретать обновления.
Дополнительно большое количество пользователей, периодически возвращающихся на сайт, улучшает и так называемые “поведенческие факторы”, которые учитываются Google при ранжировании страниц в результатах поиска. И самое главное: онлайн-справка - это релевантный контент для сайта. Все это положительно влияет на посещаемость сайта.
DE: Почему вы начали использовать Dr.Explain, если до этого уже пользовались другими инструментами?
Проблема была в том, что нам не очень нравилось то, какой получалась справка в HelpNDoc: ни то, как она выглядит, ни процесс ее изготовления.
Основная боль возникала при обновлении нашей программы. Наш продукт постоянно обновляется и развивается. Мы разрабатываем его уже много лет и, я надеюсь, будем разрабатывать еще много лет. Интерфейс постоянно меняется и перерабатывается, и всякий раз при выходе новой версии надо заново перещелкать все панели инструментов, кнопки, окна, чтобы обновить изображения и описания в документации. Это большая рутинная работа. Если хоть что-то могло бы ее автоматизировать, это стало бы большим подспорьем. Поэтому стали изучать альтернативные способы создания справок.
В процессе исследования мы узнали о том, что Dr.Explain позволяет автоматически создавать описания для пользовательского интерфейса и его обновлений: распознает кнопки, тулбары и поля, добавляет для них подписи и выноски, красиво их располагает.
DE: Насколько легким был этот переход на Dr.Explain и что он вам дал?
Оказалось, что Dr.Explain делает все волшебным образом. Несколькими нажатиями кнопочек мы пересканировали все приложение. Теперь, понимая, что впереди у нас еще много новых версий нашей программы, в которых что-то будет меняться, мы сможем гораздо легче задокументировать обновленные варианты интерфейса. Это то, на чем мы теряли скорость раньше.
Второе достижение - это то, что справка, которая получается в Dr.Explain, имеет более профессиональный и аккуратный вид. Мне сейчас нравится, как выглядит наша справка.
Новую версию справки писала наша молодая сотрудница, тестировщица, с полным отсутствием опыта в создании документации. На написание всей справки у нее ушел примерно месяц, при этом она совмещала этот процесс с другими своими задачами. На то, чтобы полностью освоить все особенности программы, у нее ушло несколько дней. С учетом того, что у нее не было в этом вообще никакого опыта, я считаю, что это потрясающий результат.
Очень приятно, что команда поддержки Dr.Explain реагировала очень оперативно и быстро давала ответы на все вопросы нашей сотрудницы.
Кроме того, мы не просто конвертировали старую справку, а переделали ее структуру в более многоуровневую. К этой мысли нас тоже подвел Dr.Explain и то как там построена работа с разделами. Мы разделили многие темы на более мелкие разделы, с более четким фокусом.
DE: Какую оцениваете результат работы в Dr.Explain?
Считаю, что наши усилия были не зря. Сейчас мы переделали справку на русском языке и уже четко знаем, что будем переделывать справку на английском языке. Справки на всех остальных языках мы также переведем на Dr.Explain, чтобы в будущем сэкономить время на всех последующих обновлениях документации. Кстати, в связи с этим хотелось бы, чтобы программа поддерживала синхронизацию переводов справки и помогала вести документацию на нескольких языках. Надеюсь, скоро это будет реализовано. Для нас это важно, т.к. наш продукт ориентирован на глобальный рынок.
# # #
Более подробно о программе JVSG: IP Video System Design Tool для проектирования систем видеонаблюдения и о других проектах компании IPICA Ltd можно узнать на сайте jvsg.com/ru/