Middle Technical Writer

Что вы будете делать:

Контент

- Писать и редактировать руководства для разработчиков, API-документацию, описания релизов и обучающие материалы как для технической, так и для нетехнической аудитории.

- Объяснять архитектуру облачных систем, микросервисы и REST API простым и понятным языком.

- Писать сценарии для обучающих видео и сотрудничать с маркетинговой командой при создании видеоруководств.

Структура и стандарты

- Создавать, организовывать и поддерживать комплексную базу знаний, следя за тем, чтобы вся документация оставалась актуальной и точной.

- Разрабатывать и поддерживать руководства по стилю, шаблоны и лучшие практики документирования для обеспечения единообразия всего контента.

- Проектировать и оптимизировать структуру сайта и навигацию для улучшения поиска информации и пользовательского опыта.

- Оценивать, внедрять и поддерживать инструменты и инфраструктуру для создания документации: генераторы статических сайтов, системы контроля версий, CI/CD.

Сотрудничество и влияние

- Работать с разработчиками и продакт-менеджерами для получения технической информации и проверки её точности.

- Планировать, отслеживать и выполнять контентные задачи и этапы работы с использованием Agile-подходов и систем управления задачами.

- Использовать аналитику и отзывы пользователей для оценки эффективности документации, выявления пробелов и постоянного повышения её качества.

- Отслеживать форумы, обращения в службу поддержки и каналы сообщества, чтобы выявлять повторяющиеся проблемы пользователей и недостающую документацию.

Что мы ищем:

Опыт

- Более 3 лет опыта в разработке, написании и создании технического контента для разработчиков или IT-специалистов.

- Опыт документирования облачных платформ, API, инструментов для разработчиков, инфраструктурных сервисов или корпоративного ПО.

- Опыт тесного взаимодействия с разработчиками, продакт-менеджерами и другими техническими специалистами в динамичной среде разработки.

- Опыт ведения документационных проектов на протяжении всего жизненного цикла контента — от планирования и создания до публикации и дальнейшего обновления.

- Умение использовать метрики документации, отзывы клиентов и данные службы поддержки для улучшения контента.

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

Навыки

- Техническая грамотность: способность читать и понимать базовый код (Python, Java, JavaScript), а также непосредственно работать с API и инструментами для разработчиков.

- Контроль версий: Git/GitHub для подхода docs-as-code и совместной работы над документацией.

- Разметка: Markdown, reStructuredText или аналогичные языки лёгкой разметки.

- Документирование API: OpenAPI/Swagger, Postman или аналогичные инструменты.

- Платформы для документации: Document360, Confluence, ReadTheDocs, GitBook или кастомные сайты документации.

- SEO и аналитика: хорошее понимание принципов SEO и практический опыт работы с Google Analytics, Mixpanel или аналогичными инструментами.

Требования

- Высшее образование в области компьютерных наук, английского языка, технических коммуникаций или смежной области.

- Отличные письменные и устные навыки английского языка, а также портфолио опубликованной технической документации.