Привет, Хабр! Меня зовут Алиса Комиссарова, я менеджер проектов в департаменте информационной поддержки Positive Technologies.
Еще пять лет назад технические писатели Positive Technologies для создания руководств пользователя и прочей техдокументации использовали разные программы, произвольно затачивая стиль и оформление документов под свои проекты. В один прекрасный день объем разрабатываемой документации перестал поспевать за бурным ростом бизнеса и запросами наших подразделений, и мы поняли, что надо срочно что-то делать. И тогда к нам пришла она — идея корпоративного управления контентом. В этом посте я поделюсь историей о том, как мы в Positive Technologies внедряли (ох, это было непросто) систему SСHEMA ST4, профессиональную CMS для создания и управления информацией о продуктах, в рабочие процессы различных департаментов, а также расскажу:
быстро ли прижилась система в компании,
сколько сотрудников сейчас ею пользуются,
как мы продолжаем внедрять СМS в различные департаменты,
какие у нас планы на будущее.
Если вы разрабатываете документы и до сих пор не слышали о CMS и SCHEMA ST4 — обязательно читайте статью! Надеюсь, наш подход пригодится тем, кто хочет не только оптимизировать процесс работы с технической документацией, но еще и сделать его удобным и легким для всех участников.
Приемлемая цена, масштабируемая архитектура, встроенные механизмы контроля качества — нужное подчеркнуть
В 2016 году у нас в компании был целый зоопарк средств для разработки технической документации. Поначалу уследить за всем было вполне реально. Однако по мере того как Positive Technologies развивалась, выпускать документацию в срок становилось все сложнее: количество проектов постоянно росло. Кроме того, наши решения приобретают за рубежом те, кто ищет альтернативу западным разработкам, поэтому продуктовые материалы нужно локализовывать для конкретных стран. Чтобы поддержать необходимый объем и качество выпускаемых материалов и не раздувать при этом штат сотрудников, разрабатывающих и поддерживающих документацию (он за последние годы и так увеличился в 10 раз), мы всерьез задумались о том, каким способом можно было бы оптимизировать все процессы работы с документами.
Наиболее современным и технически проверенным решением стала бы, пожалуй, новая система, в которой могла бы работать команда технических писателей и где бы жил весь наш контент. Наш выбор пал на системы класса CMS (content management system, системы управления контентом). Почему именно CMS? Дело в том, что нам требовался инструмент, с которым могли бы легко взаимодействовать коллеги из разных департаментов — как специалисты, работающие с технической документацией профессионально, так и те, кто лишь изредка пишет в Word. Кроме того, нам было нужно, чтобы не только писатели и редакторы, но вместе с ними еще и инженеры по локализации, тестировщики и аналитики работали в едином пространстве, где они могли бы сразу вычитывать материал на фактическое соответствие и корректность.
Также мы хотели, чтобы система позволяла нам публиковать материалы в разных форматах, например таких, как JSON, Markdown, TXT и HTML. Как оказалось, не каждая CMS может похвастаться столь богатым набором функций.
Раз уж зашла речь о требованиях, которые мы предъявляли к системе, то перечислим главные из них:
приемлемая стоимость (сравнивали с аналогичными решениями);
соответствие техническим требованиям от IT-департамента и SOC;
удобство использования, в первую очередь для авторов (подразумевается привычный интерфейс и автоматизация действий);
гибкая расширяемая архитектура, позволяющая свободно добавлять авторов, настраивать уровни доступа, структурировать контент и автоматизировать работу с ним;
масштабируемость решения на компанию;
встроенные механизмы контроля качества;
прозрачность и удобство инструментов отчетности и аналитики;
различные возможности доставки контента конечным пользователям.
О тяжелом поиске подходящей CMS и подготовке к внедрению
Идея внедрения корпоративной системы управления контентом нашла отклик во многих департаментах Positive Technologies. К тому же нам очень повезло: топ-менеджеры не меньше нас понимали ценность такой системы и подгоняли нас с выбором. Главным катализатором и идейным вдохновителем проекта была Таня Родионова, директор по продуктовым сервисам. Она же участвовала в его реализации и разруливала все, даже самые неразрешимые сложности.
Кстати, о сложностях. Наш путь даже в самом начале легким не был: найти на российском рынке продукт, который бы отвечал нашим требованиям, нам не удалось, поэтому в 2016 году мы отправились на поиски подходящего решения в Штутгарт, где проходила международная конференция tecom. Каждый год она собирает тысячи людей, кому интересна сфера технических коммуникаций. Наши надежды оправдались: на конференции были представлены несколько новых решений, которые потенциально могли нам подойти.
Как мы начали работать в SCHEMA
Спустя пару месяцев глубокого анализа и пилотного тестирования решений по управлению контентом мы остановили свой выбор на SCHEMA ST4 (далее также — SCHEMA), разработанной компанией Quanos Content Solutions. Первое время в SCHEMA работали только три автора, включая меня. Мы импортировали несколько документов и настроили layout. Layout позволил нам верстать технические документы в унифицированном стиле и выгружать их в форматах PDF, DOCX или CHM. Параллельно мы наполняли собственную базу знаний о SCHEMA в корпоративной wiki. Как только layout был готов, к нам присоединились остальные писатели нашего департамента информационной поддержки. Софт, который мы раньше использовали для документирования, теперь нам стал не нужен.
Техрайтеры довольно быстро привыкли к SCHEMA, во многом благодаря адаптированному интерфейсу Word, позволяющему создавать контент. На следующем этапе работы с системой мы научились делить контент на кусочки для последующего переиспользования. Например, те шаги из инструкций, которые часто повторяются, были помещены во фрагменты, а названия продуктов Positive Technologies — в переменные.
На картинке выше в тексте зеленым цветом выделены переменные, в нашем случае — названия продуктов Positive Technologies. Они выбираются при публикации. Присмотревшись к скриншотам справа, можно заметить, что полное и краткое название продуктов — единственное, что отличает абзацы друг от друга.
«Если уж решили работать в корпоративной CMS, то и писать надо в корпоративном стиле!»
Так решили мы в Positive Technologies и одновременно с подбором платформы для управления контентом составили руководство по стилю для технической документации. Помимо этого, мы закрепили на уровне стандарта комплект документов, сопровождающих продукты, базовую структуру документов, а также согласовали их общие разделы.
Весь контент, который у нас был на тот момент, был переработан. Зачем нам это было нужно? Единый подход позволил авторам заимствовать части разделов друг у друга (те самые, уже вошедшие в обиход reuse и single-source ). Благодаря подстановке повторяющихся сегментов нам удалось значительно сократить время, которое сотрудники тратят как на анализ и редактирование, так и на перевод.
Кто такой архитектор контента и зачем он нужен
База контента в SCHEMA стала сильно разрастаться, поэтому мы договорились о том, как будем именовать ее объекты (фрагменты, переменные, видеоролики, диаграммы и скриншоты), чтобы в ней легче было ориентироваться. Однако в скором времени появилась необходимость контролировать соблюдение принятых норм и помогать авторам правильно создавать и хранить контент, причем заниматься этим надо было не время от времени, а на постоянной основе. Чтобы решать эти задачи, мы выделили в команде особую роль — архитектор контента. Так я стала первым архитектором контента в Positive Technologies. Интересно, что в нашей стране эта специализация еще только формируется, тогда как на международном уровне она уже признана.
Став архитектором контента, я систематизировала объекты в базе, настраивала layout и создавала шаблоны публикаций. Так как архитектор — это своего рода первопроходец, я также первой осваивала функции системы, а затем рассказывала о них коллегам по команде. Еще в мои обязанности входило обучение новых коллег, чистка контентной базы, общение с техподдержкой SCHEMA и администрирование пользователей, то есть настройка групп и их привилегий в системе. В 2017 году должность архитектора контента была введена в штатное расписание компании, так что теперь архитектором можно стать официально.
Подробнее об этой роли мы рассказывали в 2017 году на профильной конференции «Гипербатон», а в 2018-м — на конференциях «ProКонтент» и SECR. Сейчас для решения архитектурных задач есть рабочая группа, в которой несколько специалистов совмещают роль архитектора контента с ролью технического писателя или менеджера проектов.
Вовлекаем все больше коллег
Затем к работе подключились и редакторы. Для удобства вычитки мы используем облегченный веб-интерфейс, где оставить комментарий можно в два клика. Сегодня пользователи нашей CMS могут просматривать историю комментариев, а также оценивать степень покрытия документов вычиткой и их готовность к релизу продукта, не применяя при этом дополнительных инструментов.
К 2018 году мы в нашей CMS работали с большинством продуктов Positive Technologies. Кроме того, в ней было около 400 документов — в два раза больше, чем годом ранее. Однако желаемый уровень качества материалов еще не был достигнут: документы могли содержать ошибки, которые нам было сложно отловить. Поэтому к вычитке в SCHEMA подключились инженеры по качеству, аналитики и другие стейкхолдеры. К 2019 году в корпоративной CMS работали около 100 человек. Сначала ребята редко заходили в систему, потому что новый процесс проверки документов, как, впрочем, и сама система, были им непривычны. Кроме того, наши ревьюеры периодически сталкивались с системными багами, которые их раздражали и мешали работе. Сейчас мы прокачались и научились разбираться с багами любой сложности. Процесс построен так: ребята пишут заявку, в которой сообщают о баге, по ней автоматически заводится тикет в трекере, дальше архитектор контента либо самостоятельно, либо с помощью официальной техподдержки SCHEMA решает возникшую проблему.
А поговорить?
Чтобы быстрее делиться опытом и не рассказывать о функциях системы каждому сотруднику по отдельности, мы завели чат для технических писателей и редакторов, в котором до сих пор обмениваемся полезной информацией. В следующему году для быстрого распространения новостей о фичах (о новых функциях SCHEMA ST4 и наших собственных доработках в ней) мы планируем делать рассылки на коллег.
За четыре года количество версий документов увеличилось, и вот незадача: стандартный сценарий вычитки в SCHEMA нам на этом этапе уже не подходил, так как в нем нельзя было указать, для какой версии продукта необходимо проверять контент. Поэтому нам потребовалось доработать сценарий под нужды нашей компании силами архитекторов. Сегодня при отправке раздела документа на вычитку можно для контекста прикрепить к задаче промежуточную версию файла в формате PDF, указать разные дедлайны для каждого участника вычитки, а также разрешить редактору вносить исправления, если он, к примеру, найдет ошибку в определении термина. Да, базу терминологических статей мы также поддерживаем в CMS.
Новые типы контента и новые авторы: система управления контентом завоевывает Позитив
В 2019 году мы полностью наладили работу с техническими документами в компании. Но CMS ценна еще и тем, что позволяет управлять контентом не только в рамках одного отдела, но и в масштабах всей организации. Поэтому, пока наши технические писатели погружались в систему, их старшие коллеги уже демонстрировали возможности и преимущества использования CMS руководителям других подразделений, делились с ними впечатлениями и совместно строили планы по дальнейшему развертыванию системы в компании. Как только архитектура была выстроена, мы начали расширять базу контента, загружая в нее остальные материалы, необходимые на разных этапах жизненного цикла продуктов — методические пособия для тренингов отдела образовательных программ, описания условий технической поддержки, а также материалы для предпродажной подготовки (ТКП, анкеты для пилотов, политики лицензирования).
Отмечу, что часть контента, написанного писателями ранее, мы используем в документах других подразделений, иначе говоря, «погружаем» контент в новые документы. Когда контент обновляется, исправления автоматически попадают во все точки переиспользования, например в раздел «Установка продуктов». Аналогично работает этот процесс и в обратную сторону: если в техническом документе используется контент из документа других подразделений, обновление этого контента автоматически подхватывается в нужных местах — так действует ранее упомянутый в статье reuse. Благодаря этому подходу мы добились до 40% переиспользования контента между двумя разными проектами и до 90% переиспользования внутри одного проекта между разными документами.
Чтобы стало понятнее, приведу пример на продуктовых материалах PT MultiScanner. Раздел «Что нового в версии» в справке о продукте и разделы «Новые возможности» и «Улучшения» в release notes заимствуют контент друг у друга.
Нам очень хотелось бы, чтобы у коллег было больше времени на изучение всех возможностей нашей системы управления корпоративном контентом. А мы, в свою очередь, всегда готовы им помочь, чем можем. Например, для тех, кто не может выделить на знакомство и изучение системы столько же времени, сколько и технические писатели, мы подготовили учебные видеоматериалы и практические задания для быстрого старта.
Помимо видеоуроков, предлагаем коллегам живые обзоры функций системы и время от времени проводим презентации, посмотреть которые может любой сотрудник компании. К каждому автору мы стараемся найти индивидуальный подход, чтобы процесс его адаптации проходил комфортно. Так, например, архитектор контента сопровождает автора на всех этапах разработки контента, а также находится в курсе всех проектов, чтобы своевременно оказать помощь и не позволить превратить работу с системой в хаос.
Затрагивая тему новых типов контента, отмечу, что одними из последних в систему мы «погружали» документы для сертификации, в частности формуляры для сертификации MaxPatrol SIEM и PT MultiScanner во ФСТЭК. Для этого нам потребовалось не только разработать новые шаблоны под разные размеры страниц (А4 и 175 × 130), но и спроектировать layout с учетом требований ГОСТа. Этими документами теперь может пользоваться отдел операционного маркетинга, при этом заказывать дополнительную доработку шаблона в типографии им больше не нужно. Для быстрой публикации документов из нашей системы мы составили реестр, где указали идентификаторы нужных объектов в базе CMS. По нему коллеги могут легко найти в системе нужные им документы и самостоятельно опубликовать их в любой момент.
Как SCHEMA помогает: массовая публикация соглашений
Сейчас вместе с командой по защите прав на интеллектуальную собственность заканчиваем погружение EULA в SCHEMA. Теперь пользовательские соглашения для любого из продуктов Positive Technologies мы можем перевыпускать всего за несколько минут и в любой версии — как в стандартном виде (в том числе на английском), так и в нестандартном, например для сертификации в Казахстане. До появления SCHEMA нашим специалистам приходилось вручную поддерживать несколько форматов сразу, на что тратилось много времени.
Доля переиспользования контента между пользовательскими соглашениями достигает 95%, поэтому с этими документами намного удобнее работать в SCHEMA — в ней не нужно «копипастить» из одного окна в другое.
Про поддержку системы и автоматизацию рутины
Поддерживать SCHEMA архитекторам контента помогают два технических писателя. За счет совмещения ролей они могут участвовать в разнообразных задачах, в частности бороться с рутиной с помощью автоматизации. Например, мы в Positive Technologies научились автоматизировать в системе ряд однообразных действий, расширять свойства объектов и настраивать автопроверки. Последние нужны нам для поиска часто встречающихся ошибок в тексте и структуре документа, кроме того, они помогают обнаружить неточности в использовании стилей и несоблюдение принятых в компании соглашений. Доработанные системные и наши собственные отчеты помогают сервис-менеджерам собирать профили качества, которые позволяют определить степень готовности документа к релизу. Отчеты можно собирать как для документов на языке-источнике, так и на языках перевода. Чтобы оценить качество выпускаемых материалов, менеджер проектной команды обязательно просматривает отчеты об истории вычитки отдельных разделов и о покрытии вычиткой всего документа. Вот как, например, выглядит отчет о качестве руководства пользователя PT Sandbox (версия 0.9).
Кстати, не могу не похвалиться: после того, как у нас появилась SCHEMA, мы стали рассказывать о ней коллегам по отрасли, выступая на различных российских конференциях. Кроме того, в качестве экспертов мы принимаем участие в конференции SCHEMA, где делимся своим опытом внедрения и лайфхаками. А еще в стенах родной компании мы проводили профильный митап, где сравнивали SCHEMA ST4 с другими популярными CMS.
CMS в компании: сегодня и завтра
Создание и управление контентом в CMS — это увлекательный процесс, полный вызовов. Выбранная нами платформа постепенно приживается в компании и становится по-настоящему корпоративной. Сейчас в ней работают более 200 пользователей, что составляет почти 20% всех сотрудников компании. Среди них — технические писатели, редакторы, аналитики, переводчики, тестировщики, инженеры по локализации, юристы, специалисты по сертификации, разрботчики, сотрудники отдела обучения и многие другие. Каждый квартал мы принимаем около 150 заявок в виде рабочих запросов, пожеланий по улучшению и разработке новых функций и шаблонов.
В настоящее время мы поддерживаем все продукты Positive Technologies, но зная амбициозную контент-стратегию компании, готовимся к дальнейшему увеличению объемов выпускаемых материалов. Не сомневаемся, это подстегнет интерес к CMS внутри компании. В планах нашего департамента — выстроить процессы так, чтобы техническую документацию можно было не только создавать в едином стиле, но и при необходимости легко менять его, причем с сохранением такого же подхода к разработке, одинаковыми шаблонами верстки и без противоречий в контенте.
P.S. Эта статья не появилась бы на свет без участия моих коллег — Саши Михайлова, руководителя отдела управления контентом, и Иры Рыбниковой, руководителя департамента информационной поддержки. Ребята, огромное вам спасибо за помощь!