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

Мы разрабатываем современную XRM-платформу, состоящую из набора сервисов и API, которые используются внутренними командами разработки и внешними интеграциями. Ищем Technical Writer, который поможет сделать документацию понятной, актуальной и полезной для разработчиков.

Обязанности:

• Исследовать REST API и описывать его поведение на основе OpenAPI (Swagger), кода и общения с командой разработки.
• Создавать и поддерживать документацию по API, сервисам и интеграциям.
• Готовить примеры запросов и ответов, сценарии использования и инструкции для разработчиков.
• Работать с разработчиками, аналитиками и QA для уточнения логики работы сервисов.
• Поддерживать документацию в актуальном состоянии по мере развития продукта.
• Работать с Git-репозиториями и генераторами документации (Antora, Docusaurus или аналогичными).
• Участвовать в формировании единых стандартов оформления технической документации.

• Опыт подготовки технической документации для разработчиков (API, SDK, сервисы, интеграции).
• Уверенное понимание принципов REST API.
• Опыт работы с OpenAPI / Swagger.
• Понимание структуры HTTP-запросов и ответов:
  • методы HTTP;
  • path, query и body-параметры;
  • headers;
  • коды состояния;
  • модели данных и сериализация JSON.
• Опыт проверки API с использованием Postman, curl или аналогичных инструментов.
• Умение быстро разбираться в технической информации, анализировать код и требования.
• Грамотный технический русский язык, умение писать понятно, кратко и структурированно.
• Навык эффективного взаимодействия с разработчиками и аналитиками.
• Готовность выполнить небольшое техническое задание перед интервью.
• Будет плюсом:
• Понимание C# и платформы .NET.
• Опыт работы с Git по принципу Docs-as-Code.
• Знание Markdown, AsciiDoc или других языков разметки.
• Опыт использования Antora, Docusaurus, MkDocs или аналогичных генераторов документации.
• Знакомство с CI/CD-процессами публикации документации.
• Опыт работы в продуктовых или интеграционных командах.

• Работу над современной микросервисной платформой с большим количеством REST API и интеграций.
• Возможность влиять на стандарты технической документации продукта.
• Команду опытных разработчиков, аналитиков и QA, готовых делиться экспертизой.
• Гибкий формат работы, профессиональное развитие и участие в создании документации, которой ежедневно пользуются команды разработки и партнеры компании.