Top.Mail.Ru
Все вакансии

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

Мы в поиске технического писателя на проект нашего партнёра — крупной технологической компании. Продукт: сервис облачной платформы для управления и контроля доступа к облачным ресурсам: аутентификация и авторизация пользователей на базе OpenSource-компонентов.

Middle

Что нужно делать:

  • Разработка и поддержка технической документации продукта.
  • Документирование REST API (Swagger/OpenAPI); описание flows аутентификации и авторизации (OAuth 2.0/OIDC, JWT, Keycloak).
  • Ведение Runbook / Troubleshooting Guide, Release Notes / Changelog, README, ADR.
  • Работа по Docs-as-Code: Git + Markdown → CI/CD → статический сайт; ветки, PR, review, линтеры документации.
  • Создание диаграмм (PlantUML / Mermaid / Draw.io), скриншотов и скринкастов для user-facing документации.
  • Документирование сценариев авто-тестирования, подготовка отчётов по результатам тестирования.
  • Взаимодействие с аналитиками, разработкой и DevOps: документация как часть Definition of Done, участие в демо и сбор обратной связи.

Что мы ждем от будущего коллеги:

  • Опыт разработки технической документации от 2 лет.
  • Опыт документирования API и систем аутентификации; широкий кругозор в ИТ (сети, ОС, БД, API).
  • Понимание OAuth 2.0 / OpenID Connect на уровне описания flows, структуры JWT; знакомство с терминологией Keycloak (Realm, Client, Role, User, Authentication Flow).
  • Обзорное понимание TLS: версии, handshake, сертификаты (CA, самоподписанные, цепочка доверия).
  • Уверенный Git.
  • Docs-as-Code на практике: Markdown (tables, admonitions, includes), генераторы статических сайтов (MkDocs, Docusaurus, Antora или аналоги) Swagger/OpenAPI (Redoc, Swagger UI), PlantUML / Mermaid / Draw.io
  • Опыт написания руководств администратора и пользователя, API Reference, Runbook, Release Notes, README
  • Знание ГОСТов на документацию (ГОСТ 34.602, ГОСТ 19.402)
  • Навыки работы с генеративными AI-моделями, опыт создания и использования AI-агентов для анализа, генерации и автоматизации

Условия

  • Срок привлечения: 3–6 месяцев (с возможностью продления)
  • Занятость: Фулл-тайм
  • Формат работы: Удаленно (только из РФ)
  • Ставка: 525 – 650 руб/час

Ключевые навыки

  1. Техническая документация
  2. REST API
  3. Docs-as-Code
  4. Git
  5. OAuth 2.0
  6. PlantUML

Другие вакансии

  • Фулл-таймУдаленно в РФ
    Системный аналитик (Senior)

  • Фулл-таймУдаленно в РФ
    Системный аналитик (Senior)

Откликнуться на вакансию