Мы в поиске Технического писателя в международную компанию к нашим партнерам, который поможет в разработке удобной API-документации.
Обязанности:
- Общаться с разработчиками, аналитиками и тестировщиками
- Исследовать API и документировать его поведение
- Писать статьи и справочные материалы, поддерживать актуальность документации
- Работать с Git-репозиториями и генераторами сайтов документации
Требования:
-
Опыт работы с API: умение читать OpenAPI (Swagger), разбираться в структурах запросов и моделей
-
Опыт в описании API / SDK для разработчиков
-
Навык отправки запросов к API через Postman, curl или аналогичные инструменты
- Понимание структуры REST-запросов (path, query, body, headers, status-коды)
- Способность писать кратко и логично, выделять смысл, понимать техническую суть
- Умение общаться с разработчиками и вытаскивать смысл из кода и ТЗ
- Готовность выполнить небольшое тестовое перед техническим интервью
Будет плюсом:
- Знание принципов docs-as-code (GIT), AsciiDoc или Markdown
Этот опыт может не подойти, если:
- Никогда не открывали код (особенно C#) и не планируете
- Копируете описание из ТЗ без верификации
- Рассматриваете документацию как текстовую или оформительскую задачу, а не как инженерный артефакт
Условия:
- Удаленный формат работы
- Корпоративная скидка 50% занятия по английскому языку SkyEng
- 4 дополнительных day off в году
- Оплачиваемый больничный и отпуск