Арина Балерина

Моя специализация — публичная документация для разработчиков. И мне нравится влюблять людей в профессию :) Сама я влюбилась так.

Сначала я работала IT-консультантом в проектных компаниях, которые занимаются автоматизацией. В 2013 году я пришла документировать API в Яндекс, в сильнейшую тогда команду техписателей.

В 2020 году я пришла ВКонтакте, где до этого не было технических писателей. Я запускала новый портал с документацией для разработчиков. Для этого потребовалось придумать структуру портала, собрать команду писателей, написать гайды, настроить всех на сотрудничество, и запустить всё это в работу.

Как руководитель я джун. Зато как техписатель я очень даже синьор. Синьора :) Уже 20 лет я работаю над самыми разными задачами, связанными с внешней и внутренней документацией. Я работала в СберТехе, КОРУС Консалтинг, блокчейн-компании Bitfury, в собственном издательстве и в небольших айтишечных компаниях. На каких работах я хожу, можно посмотреть в Linkedin.

О том, как понять, надо ли становиться писателем, я рассказывала в подкасте на канале «Техпис говорит».

Техническому писателю

Я вычитываю ваши тексты, но не только как редактор. Пока вычитываю, я рассказываю, что знает и о чём думает зрелый технический писатель.

Я могу общаться на русском и английском, но документацию пишу на русском языке. Если вы тоже пишете на русском, я буду придираться к каждой лишней скобке, неправильной кавычке и недостаточно длинному тире. А ещё я люблю Питон)

TL;DR для тех, кто только начинает

Если очень коротко, можно стать разработчиком технической документации, который описывает графические или программные интерфейсы, или и те и другие.
Пример графического интерфейса — это веб-интерфейс облачного сервиса, где вы храните свои файлы. У этого же облачного сервиса может быть и программный интерфейс, который позволяет другим приложениям с ним общаться. Например, это может быть SDK для мобильных приложений и HTTP API для всех остальных. Описывать всё это очень интересно!

На первой встрече мы обсудим ваши цели, ресурсы и способы, которыми можно достичь целей. Возможно, вы поймёте, что вам нужен не ментор, а, например, курсы. Если всё-таки ментор, то на следующих встречах я буду давать вам задания. Например, написать какой-нибудь полезный текст, на русском языке. Мы с вами будем разбирать удачные и неудачные решения, и, таким образом, через вычитку, набивать руку.

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

Аналитику

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

Нанимающему менеджеру

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

Менеджеру проекта и разработчику

Если вы менеджер проекта и хотите документацию «как у Яндекса», то вам нужен единый источник и инфостиль. Я знаю, что это, и как это внедрить.

Если вы разработчик и вам нужно просто спросить про docs-as-code, я могу рассказать про MkDocs и Markdown, ведь про Git вы и так в курсе. Это я использовала в работе. Но посоветую я вам скорее всего Sphinx и ReST ^) Возможно, вам просто будет интересно узнать про то, что для совместной работы над документацией нам тоже подходит Git, а разработчика Doxygen можно спросить про доработки генератора документации, чтобы всем было удобно.

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