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

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

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

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

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

• Как понять, надо ли становиться техписателем: подкаст.

• Коротко про DocOps, ГОСТ, крипту и кринж: подкаст.

• Взгляд на техписателей внутри энтерпрайза: подкаст.

• Кто такие техписатели и как они мыслят: митап.

• Блог про работу: Linkedin.

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

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

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

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

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

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

А кто такой этот технический писатель в IT? Чаще всего это специалист, который описывает графические, программные или текстовые (командные) интерфейсы какого-нибудь софта.
Пример графического интерфейса — это веб-интерфейс облачного сервиса, где люди хранят свои файлы. Его пользователям нужна понятная инструкция. У этого же облачного сервиса может быть и программный интерфейс (API), который позволяет другим приложениям с ним общаться. Например, это может быть SDK для мобильных приложений и HTTP API для всех остальных. Разработчикам этих «других приложений» будет тяжело без справочника. А ещё бывают утилиты или приложения, с которыми можно общаться только из командной строки (CLI). Таким приложениям тоже нужна документация.

Аналитику

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

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

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

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

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

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

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