Технический писатель на английском / DocOps

Привет, мы — команда Icons8. Мы создаем дизайн элементы и сервисы: иконки, редактор стоковых фото, редактор Lunacy, музыку, иллюстрации, и даже портреты несуществующих людей. Для всего этого есть софтинки и есть API.

Кто нужен?

Опытный технический писатель

Тот, кто любит писать документацию кратко и понятно. Мы ждем от вас, что вы знаете, как это делать, от начала и до конца:

1. можете сами сформулировать ключевые задачи
2. структуру
3. набросать иллюстрации и скриншоты (красота не обязательна)
4. отформатировать в markdown.

Знание английского

Все это надо делать на английском языке. Мелочи вроде пропущенного артикля может пофиксить Grammarly или редактор, но варианта "писать на русском, потом переводить" нет.

Есть нужно немного подтянуть, мы готовы оплачивать вам курсы на itlaki.

Техническая подкованность

Мы надеемся, что вы видели Swagger и сможете написать документацию для такого API. 

Почитать и поразбираться — ок, но впасть в ступор и тянуть из программистов готовые формулировки — нет.

Кто-то, кто чувствует текст

Самый главный критерий — это понимать мысль и последовательно ее рассказывать. 

Мы часто видим тексты, которые слеплены из обрывков информации. 

Мы видим тексты, которые напичканы фразами-клише вроде "fast and easy way".

Мы видим тексты, из первых строк которых непонятно, о чем будет рассказ.

Нам больно. Мы надеемся, что вам от этого тоже больно. Что у вас есть внутренний датчик качества, который заклинивает от мусорного текста. Мы надеемся, что мы будем страдать вместе, и радоваться, когда получается, тоже вместе. Если вы немножко как я, то знаете, каково это — текст, который хочется перечитывать.

Кому нравится неформальный стиль 

Нам не перед кем отчитываться, сертифицироваться, и трепетать. Мы в добных отношениях с пользователями, и можем себе позволить писать не по внешним стандартам, а по собственным. 

Можно вставить шутейные данные в запрос, нарисовать жирафа в качестве персоны, или включить ссылку на сторонний туториал.

Мы будем помогать

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

Примеры 
Примеры хорошей документации

Начать хотелось бы со сложного для наших клиентов — с API:

• Stripe — пробирает до мурашек. А API reference какой!
• Unsplash — мило, и они близки к нам по предметной области

Потом можно перейти к приложениям: 

• Basecamp — бабочки в животе
• Sketch — аккуратно и с гифками.

Примеры нашей документации

Наши доки пока недотягивают, скажем так. Вот:

• Lunacy
• Icons (почему-то веб-приложение в одной доке с API)
• Мини-howto: Line Awesome, OMG IMG.

Благородно на этом фоне выглядит голый Swagger: 

• Photos
• Music

В общем, помогайте!

Ничего себе требования. Это все?

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

Кто не нужен

• Кто-то, кто будет эту работу терпеть, а не получать удовольствие.
• Тот, кому совсем нечего показать из сделанного. 

Уговор

1. Вы работаете от года до трех, в течение которых не предполагается радикальной смены деятельности и размера оплаты.
2. За это время вы становитесь отличным специалистом, который может с нуля поднять контент-проект для любой технической компании. Вы можете выбирать из массы вариантов.
3. За 3 месяца до окончания вышеупомянутого срока мы говорим о том, как поступим дальше:

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

Наши принципы

• Позитивное мышление: мы не понукаем, не виним и не угрожаем. Мы не считаем, что люди рождены ленивыми, и нужно их запугать до смерти, чтобы что-то делали.
• Свобода: каждый из нас выбирает между офисом в центре Москвы, Бали, Аргентиной, Магнитогорском и так далее.
• Доверие: наши сотрудники тратят деньги компании без спросу и работают когда хотят, но нужно отработать 35 часов в неделю и быть на daily standup в 13:30 по Москве.
• Все делаем вместе: мы созваниваемся и вместе ковыряемся в коде, и не любим длинные портянки в бейскампе, делегирование и написание отчетов.

Подробнее о том, как мы работаем (от культуры до отпусков) — в нашем Welcome Guide.

Как откликнуться

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

Если вы не супер-опытный, сделайте небольшое тестовое задание: выберите какую-то из наших документаций (см выше) и напишите:

1. Предлагаемую структуру
2. Полстранички-страничку текста