Технические писатели в Яндексе

11 ноября 2013, 13:50

В Яндексе, как и в других крупных компаниях, очень много разных подразделений. Большие и маленькие, всем известные и такие, о работе которых пользователи сервисов Яндекса задумываются редко. Одно из таких подразделений — служба разработки технической документации.

Техническая документация — это инструкция или справочник, объясняющий, как работать с сервисом или как он устроен. Вы наверняка сталкивались с технической документацией — если не в разделе «Помощь» на Яндексе, то в виде инструкции к стиральной машине. От понятности и грамотности технической документации зависит удобство работы со многими сервисами. Например, документация позволяет владельцам магазинов узнать, как правильно зарегистрировать свой магазин на Яндекс.Маркете, а клиентам Яндекс.Директа помогает правильно составить текст рекламного объявления.

Кроме «Помощи» для пользователей у Яндекса есть документация для разработчиков и других технических специалистов – описания технологий, руководства и справочники по использованию API (программных интерфейсов) сервисов Яндекса. Например, документация на технологию БЭМ или API Карт. Также много внутренней документации, предназначенной для сотрудников Яндекса. Без нее вся информация хранилась бы только в голове у людей, и им пришлось бы бесконечно рассказывать всем заинтересованным, как протекает тот или иной процесс или как правильно реализовать ту или иную функцию.

Служба разработки технической документации существует в Яндексе с сентября 2006 года. Это одно из постоянно развивающихся подразделений. Сейчас в нашей службе работает уже 25 технических писателей. Четверо специализируются на написании инструкций для пользователей, пятнадцать – на разработке документации для разработчиков, а остальные делают и то, и другое. 

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

Полученные работы оценивались по тем же критериям, которые мы используем при проверке своей документации:

  • Структура. В хорошо организованном документе легко искать нужную информацию. 
  • Язык изложения. Справочники и руководства не читаются как романы. В технических текстах важно ясно и коротко донести смысл. В идеале каждое предложение должно быть понятно с первого прочтения.
  • Полнота. Важно не потерять нужную информацию. При этом не стоит путать полноту с избыточностью.
  • Точность. Информация должна быть изложена фактически точно и технически грамотно.
  • Полезность для целевой аудитории. Документ обязан отвечать на вопросы тех пользователей, для которых он предназначен.

Первое место заняла Наталья Воронцова из Москвы. Второе место разделили Инна Якименко из Санкт-Петербурга и Егор Абраменко из Барнаула. Работы Инны и Егора очень разные, и каждая хороша по-своему, поэтому мы решили присудить второе место обоим участникам.

Выполненные работы мы не публикуем. Но авторы вольны сделать это сами на любых площадках.


Светлана Каюшина, руководитель службы разработки технической документации

22 комментария
Подписаться на комментарии к посту

Яндекс отличный поисковик. Только в последнее время почти при каждом запросе просит вводить капчу. Реально начинает раздражать.

К обычным пользователям у Яндекса вопросов нет, они начинаются когда кто-то занимается массовыми рассылками.

P.S. Знакомая ситуация с капчой, пришлось к провайдеру обращаться в свое время.

Михаил Тарасенко
11 ноября 2013, 18:24

Яндекс был отличным поисковиком. Но сейчас , видимо из-за введения островов - выдачу яндекса лихорадит.

Окна — не люди. )

 

Капча на Яндексе только для избранных! Радуйтесь! ;-)

Комментарий удалён
Практически все технические писатели занимаются разработкой внутренней документации.

Если авторы захотят опубликовать свои работы, как об этом можно будет узнать?

Чрезвычайно любопытно, как они с регулировщиками разобрались))

Привет. 

Мою работу можно посмотреть здесь: http://yadi.sk/d/xWrbxcE2CYThR

Спасибо!

Надеюсь, с юмором были работы, заслужившие такие высокие оценки?

Честно говоря, не очень понимаю, какие недостатки у Правил дорожного движения. Они написаны именно так, чтобы чётко регулировать взаимоотношения всех сторон, и прекрасно со своей задачей справляются. И при этом вполне удовлетворяют именно тем требованиям, которые вы привели.

При прочтении ПДД, оказадлсь, что, да, мало "воды". И чтобы серьезно сокращать текст, надо выяснять необходимость выделения информации в отдельные блоки и пр. На например почему бы не такую формулировку (типичный канцеляризм) «указывает на разрешенные направления» – не заменить на «разрешает направления»? Все-таки количество знаков сокращает.

А ПДД  и весь отечественный свод законов не мешало бы дополнить инфографикой. (Инфорграфика так когда-то и зародилась как наука, когда правительство США поставило задачу сделать тексты своих законов более понятными и доступными для "пользователей".)

Kазаков Алексей
12 ноября 2013, 09:49

Недостатков немного, разве что очень выкрученные констукции предложений, которые читать не так просто. 

 

 Кроме того, не ахти удобно переходить по ссылкам (мол, см. такое-то постановление в такой-то редакции). И, как заметили выше, картинки и инфографика очень повышают читаемость и понимаемость текста.

 

Добрый день, Светлана!

Спасибо за пост. А есть ли в Яндексе вакансии технических писателей на данный момент?

Я хотел бы претендовать.

Да, есть. У нас открыто четыре вакансии в Москве, Санкт-Петербурге и Екатеринбурге.

Ссылка ведет в никуда :)

Поправьте ссылку плз...

Поправила.

Иногда задумавал вопросом, кто пишет техн. документацию...

Ссылка на PDF-ку с моим вариантом правил на Я.Диске.