Описание должности
Как технический писатель, вы будете играть ключевую роль в создании и поддержке всеобъемлющей документации по продукту, которая поможет пользователям и разработчикам эффективно использовать наши программные решения. Эта должность требует сотрудничества с кросс-функциональными командами для обеспечения точной и актуальной информации, предоставляемой в различных форматах, включая руководства пользователя, учебные пособия, спецификации API и документацию SDK. Вы будете работать в среде гибкой разработки, чтобы согласовать документацию с развивающимися функциями продукта и потребностями пользователей, внося вклад в общий успех нашего жизненного цикла разработки. Идеальный кандидат также будет отвечать за организацию и централизацию технической информации в компании, обеспечивая согласованность и доступность для всех заинтересованных сторон.
Ключевые обязанности
- Создание и поддержка документации по продукту, включая руководства пользователя, справочники API и руководства SDK, обеспечивая ясность и удобство использования как для технических, так и для нетехнических аудиторий.
- Разработка материалов для адаптации, таких как учебные пособия и пошаговые руководства, чтобы помочь пользователям и разработчикам быстро понять и интегрировать наши продукты.
- Тесное сотрудничество с инженерами, менеджерами по продукту и командами QA для сбора требований, проверки технических деталей и обеспечения отражения последних обновлений продукта в документации.
- Создание и обновление спецификаций API с использованием стандартных инструментов и форматов, таких как OpenAPI или Swagger, для поддержки процессов интеграции и разработки.
- Работа с заинтересованными сторонами по всей компании для сбора, организации и централизации технической информации, поддержание единой базы знаний.
- Проведение исследований пользователей для выявления пробелов в документации и улучшения пользовательского опыта за счет целевых обновлений контента.
- Проверка и пересмотр существующей документации для обеспечения точности, согласованности и соответствия стандартам компании и руководствам по брендингу.
- Участие в agile-мероприятиях, таких как планирование спринтов и ретроспективы, чтобы обеспечить итеративную разработку документации и соблюдение сроков проекта.
- Проектирование интуитивно понятных и масштабируемых структур документации, поддерживающих как внутренние команды, так и внешних клиентов.
- Обеспечение того, чтобы вся документация была под контролем версий, доступна для поиска и доступна через централизованные платформы, такие как Confluence или внутренние порталы.
Требования к должности
- Подтвержденный опыт работы техническим писателем или в аналогичной роли, с сильным портфолио проектов технической документации.
- Отличные навыки письменного и устного общения, с способностью переводить сложные технические концепции на ясный и лаконичный язык.
- Владение инструментами документации, такими как Markdown, Confluence, и системами контроля версий, такими как Git.
- Глубокое понимание принципов проектирования API и способность создавать подробные спецификации для RESTful-сервисов и SDK.
- Способность работать самостоятельно и в команде в условиях быстрой agile-среды, соблюдая жесткие сроки без ущерба для качества.
- Знание методологий, ориентированных на пользователя, и способность создавать документацию, улучшающую пользовательский опыт и внедрение.
- Внимание к деталям и приверженность точности, обеспечивая правильное отражение всей технической информации в документации.
- Опыт работы с фреймворками и инструментами документации, поддерживающими автоматическую генерацию, такими как Swagger или API Blueprint.
- Способность проводить интервью или сотрудничать с техническими командами для сбора требований и уточнения сложных концепций.
- Отличные организационные навыки, с способностью управлять несколькими проектами документации одновременно и эффективно расставлять приоритеты.
- Глубокое понимание жизненного цикла разработки программного обеспечения и способность согласовывать документацию с выпусками и обновлениями продукта.
- Способность создавать и поддерживать шаблоны документации, обеспечивающие согласованность всех материалов по продукту.
- Опыт работы с системами управления контентом и способность публиковать документацию на внутренних и внешних платформах.
- Отличные навыки решения проблем, с способностью выявлять сложности в документации и предлагать инновационные решения.
- Способность работать с минимальным контролем, беря на себя ответственность за результаты документации и обеспечивая своевременное завершение.
- Знание стандартов доступности и способность создавать инклюзивную документацию, соответствующую нормативным требованиям.
- Сильные навыки сотрудничества, с способностью эффективно работать с кросс-функциональными командами и заинтересованными сторонами.
- Опыт локализации и перевода документации для глобальной аудитории, если применимо.
- Способность предоставлять обратную связь по процессам документации и вносить вклад в инициативы по непрерывному улучшению.
- Отличные навыки управления временем, с способностью соблюдать сроки проекта при поддержании высоких стандартов качества документации.