Технический писатель в команду Лояльности
По договоренности
Что нужно делать
- описывать реализованные фичи, сервисы и исправления на основе готовых материалов (ADR, схем, обсуждений с командой);
- создавать и поддерживать архитектурную документацию по существующим решениям: UML-схемы (Sequence, ERD, DFD), диаграммы в формате C4;
- документировать контракты взаимодействия между сервисами (API-спецификации, описание интеграций) на основе готовых реализаций;
- актуализировать документацию при изменениях в продукте — отслеживать связанные задачи и поддерживать docs в актуальном состоянии;
- отвечать за финальную техническую документацию продукта на проде: документация должна позволять сверить весь функционал без дополнительных пояснений;
- описывать бизнес-фичи для внутренних команд и B2B-партнёров — понятно как для технических, так и для нетехнических читателей.
Какой опыт и знания нужны
- уверенное чтение и описание архитектурных схем: C4, UML (Sequence diagram, ERD, DFD), BPMN;
- понимание микросервисной и монолитной архитектур на уровне, достаточном для их точного описания;
- опыт документирования готовых API: REST, JSON-RPC, gRPC — написание и оформление спецификаций (OpenAPI/Swagger и аналоги);
- понимание интеграционных механизмов — умение описывать взаимодействие внешних и внутренних систем по существующим реализациям.
Будем плюсом
- знание SQL и понимание структур баз данных (в т.ч. MongoDB) для документирования схем данных;
- базовое понимание Apache Kafka — достаточно для описания событийных потоков и контрактов сообщений.
Условия:
-
удаленный или гибридный формат работы;
-
бесплатное питание в офисе (шведский стол);
-
гибкие бизнес-процессы, минимум бюрократии и согласований;
-
возможность создавать крутые продукты в крупнейшей компании;
-
разные бонусы компании: ДМС, партнерские программы по обучению и фитнесу.
Опубликована 15 часов назад
Похожие вакансии
Вакансии быстро закрываются — подпишитесь на наш канал в MAX сейчас, чтобы видеть их первыми.
Подписаться в MAX Приглашаем в команду Технического писателя, который будет создавать и поддерживать понятную, актуальную ... Обязанности: Подготовка и актуализация технической документации, инструкций, регламентов и пользовательских ...
- Можно удаленно
- Полный день
- Опыт от 1 года
- Москва
3 дня назад
Обязанности: - Создавать, редактировать и поддерживать техническую и пользовательскую документацию. - ... Требования: - Опыт работы техническим писателем / product writer / documentation specialist. - Умение ... разбираться в сложных IT-продуктах и быстро погружаться в предметную область. - Способность переводить технические ...
- Можно удаленно
- Полный день
- Опыт от 1 года
- Москва
6 дней назад
Задачи: Поддержка в актуальном состоянии технической документации компании в едином стиле. ... Разработка и выпуск технической документации в соответствии с требованиями заказчиков (инструкции, тестовая ... Высшее техническое образование.
- Можно удаленно
- Полный день
- Опыт от 1 года
- Москва
6 дней назад
В нашу команду мы ищем технического писателя, который возьмет на себя задачи по разработке текстов интерфейса ... писателей в компании. ... Чем предстоит заниматься: Разрабатывать все виды технической документации для продуктов компании (руководства ...
- Можно удаленно
- Полный день
- Опыт от 1 года
- Москва
6 дней назад
Сейчас мы в поисках опытного Технического писателя, который поможет сделать наш продукт еще лучше. ... Задачи: Разработка и систематизация технической документации для ПО. ... Практический опыт написания технической документации для разработчиков.
- Можно удаленно
- Полный день
- Опыт от 1 года
- Москва
7 дней назад