Будни технического писателя: от CIS до Стругацких

в 11:29, , рубрики: positive hack days, Блог компании Positive Technologies, перевод, метки: ,

Будни технического писателя: от CIS до СтругацкихВ любой компании, которая разрабатывает программное обеспечение, всегда есть множество задач, связанных с ведением документации и ее переводом на разные языки (особенно если компания международная). В нашем случае актуальны обе эти проблемы, а поток задач весьма значительный, поэтому на отдел технической документации ложится большая нагрузка.

В Positive Technologies технические писатели прикладывают свою руку ко всем текстам, рождающимся в недрах компании, — от сугубо технических (сопроводительная документация к продуктам, корпоративные, отраслевые стандарты) до высокохудожественных опусов с аллюзиями на Стругацких (см. легенды соревнований CTF на PHDays 2012). Если вы хотите узнать о том, как мы контролируем сроки и качество выполнения столь разноплановых задач, — добро пожаловать под кат.

Итак, для начала давайте представим направления работы по типам текстов и задач:

  • база знаний;
  • документация;
  • стандарты;
  • переводы статей, документации и стандартов;
  • переводы всего-всего для форума Positive Hack Days;
  • исследовательские статьи и маркетинговые материалы.

Теперь разберем каждый пункт отдельно.

Процесс работы с базой знаний

Развитие и поддержание актуальности базы знаний сканера безопасности XSpider и системы анализа защищенности и соответствия стандартам MaxPatrol является важнейшей задачей.

Процедура работы в данном случае следующая: после того как эксперты компании нашли уязвимость и реализовали ее поддержку программными комплексами, в отдел технической документации поступает оповещение о новой задаче: нужно создать описание уязвимости на русском и английском языках. Задача назначается конкретному работнику, он выполняет ее (создает описание или перевод), добавляет в текст необходимые ссылки, CVC-коды, после чего осуществляется коммит в базу.

Документация

Еще один класс задач — создание документации к продуктам компании (XSpider, MaxPatrol, SurfPatrol) — к примеру, постоянно идет работа по совершенствованию нескольких «Руководств пользователя» и «Руководств администратора», а также работа по переводу и дополнению других, менее масштабных документов.

Работа со стандартами

Дело приходится иметь с тремя видами стандартов.

Международные стандарты разрабатываются международными же организациями (CIS) или производителями ПО и оборудования и являются общепризнанными в сфере информационной безопасности.

После появления подобного документа задача техписателей — качественный и актуальный перевод на русский язык. В процессе перевода необходимо постоянно находиться в контакте с экспертами исследовательского центра для уточнения различных деталей.

Бывает, что стандарта для определенного ПО или устройства — не существует в природе. Такое случается нередко, и в таких случаях эксперты исследовательского центра Positive Research создают стандарты собственной разработки. Задача отдела технической документации в этом случае разбивается на две: во-первых, нужно перевести текст стандарта с «экспертного» языка на русский :) А во-вторых — уже адаптированный вариант перевести на английский.

После этого текст документа отправляется производителю ПО или оборудования и добавляется в базу знаний продуктов Positive Technologies. Впоследствии стандарт часто получает широкое распространение, становится международным.

Перевод

Казалось бы, что интересного можно рассказать про перевод? Бери текст, да переводи, чего тут сложного. Однако поток задач настолько велик, что все рутинные операции должны быть автоматизированы. В случае с переводами рутина — это перевод однотипных текстов, в которых в большом количестве встречается одни и те же термины и понятия. Два переводчика могут один и тот же термин перевести по-разному, но в сфере информационной безопасности это недопустимо, здесь нет места нечетким определениям: слишком высоки ставки. Поэтому, если какой-то термин один раз уже кто-то перевел и перевод одобрен, то в дальнейшем, когда данное понятие встречается в тексте, необходимо использовать уже готовый вариант перевода. В решении этой задачи помогает специальная система помощи при переводе (Trados).

Будни технического писателя: от CIS до Стругацких

В систему загружается исходный текст, и переводчик начинает работу с ним в отдельном окне. В дело вступает так называемый принцип памяти переведенных текстов: Trados запоминает фрагменты или отдельные слова, чтобы в будущем при обнаружении похожих слов или фрагментов в других текстах — выводить варианты их перевода. Это серьезно помогает унифицировать переводы.

Перевод для PHDays

Как вы знаете, компания Positive Technologies является организатором международного форума по информационной безопасности Positive Hack Days. Поскольку форум международный, иностранных гостей со всего мира он принимает изрядное количество. Тут и спикеры, и команды-участницы битвы CTF, и независимые исследователи. Одна из задач отдела техдокументации — сопровождение форума PHDays.

Задача эта — не из легких: перевод текстов на бумаге и последовательный перевод речи это, как говорят в Одессе, две большие разницы. Но вот уже второй год все проходит на ура :)

Конечно, перевод пресс-конференций и мастер-классов, ассистирование ведущему на самом форуме — это всего лишь верхушка айсберга. Огромное количество буклетов, статей и записей в блогах, посвященных PHDays, также попадают в заботливые руки наших техписателей и переводчиков.

Научные статьи и маркетинговые материалы

В нашем Исследовательском центре Positive Research работа по обнаружению новых уязвимостей в программном обеспечении различных вендоров ведется днем и ночью. Следуя принципу Responsible Disclosure, мы уведомляем производителей ПО о найденных уязвимостях, и только после того, как уязвимость закрыта патчем, публикуем подробное ее описание (advisory).

В ходе систематизации полученных в процессе исследований данных у экспертов исследовательского центра рождаются статьи, которые публикуются в популярных журналах и на известных интернет-площадках — как русскоязычных (Хабрахабр, журнал «Хакер»), так и иностранных (например, Hakin9).

Похожим образом в процессе решения маркетинговых и PR-задач (позиционирование компании, освещение форума Positive Hack Days) появляется большое число текстов — это записи в блогах, заметки в соцсетях, печатные промо-материалы. Все эти тексты также проходят через отдел технической документации.

При работе со всеми текстами необходимо учитывать различные параметры — приоритет задачи, необходимость перевода и редактирования, сроки. Для этого мы используем систему управления проектами по разработке документации на основе TestTrack, которая помогает нам не оказаться погребенными под нескончаемой лавиной важных документов.

Будни технического писателя: от CIS до Стругацких

Несмотря на то, что теме разработки технической документации посвящено крайне мало материалов как на Хабре, так и вообще в интернете, она крайне интересна. Если после прочтения данного топика у вас появились какие-то вопросы — мы с удовольствием ответим на них в комментариях. Всем спасибо за внимание!

P. S. Мы постоянно ищем технически подкованных, грамотных людей, профессионально владеющих иностранными языками. Если вы хотите работать в молодой, позитивной команде технических писателей и переводчиков — дайте знать!

Автор: ptsecurity

Поделиться

* - обязательные к заполнению поля