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

3 просмотра

Mish
Mish

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: branching, merge vs rebase, разрешение конфликтов, PR/review, log/diff/blame, .gitignore.
— Docs-as-Code на практике: Markdown (tables, admonitions, includes), генераторы статических сайтов (MkDocs, Docusaurus, Antora или аналоги)
Swagger/OpenAPI (Redoc, Swagger UI), PlantUML / Mermaid / Draw.io
Confluence (пространства, шаблоны, макросы) и Jira (связь задач с документацией, DoD)
— Опыт написания руководств администратора и пользователя, API Reference, Runbook, Release Notes, README
Будет преимуществом:
— Знание ГОСТов на документацию (ГОСТ 34.602, ГОСТ 19.402)
— Навыки работы с генеративными AI-моделями, опыт создания и использования AI-агентов для анализа, генерации и автоматизации

Связаться с работодателем

Важно: Редакция vseti.app не несёт ответственности за любую информацию в этой публикации, в том числе текстовое описание и графические изображения, предоставленные авторами вакансии, полученные из публичных источников интернета или от других пользователей.
Если вы нашли ошибку, пожалуйста, сообщите нам об этом на help@vseti.app или в Telegram.

Больше вакансий в нашем TelegramПодписаться