РаботаМакс
Shvacher

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

Санкт-Петербург, Приморская, Наличная улица, 44к1УдалённоПолная занятость3–6 лет

О компании

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

Ключевые факты:

  • Разрабатывают собственные системы хранения данных
  • Есть программные и программно-аппаратные продукты
  • Документация востребована у администраторов, разработчиков и техподдержки
  • Ориентация на НИОКР и требования стандартов (в т.ч. ГОСТ)

О вакансии

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

Документация в компании используется не «для галочки»: ею руководствуются системные администраторы и инженеры, специалисты технической поддержки, а также разработчики. Поэтому тексты должны быть точными, воспроизводимыми и удобными для применения в эксплуатации.

Отдельный пласт задач связан с НИОКР: нужно готовить технические и отчетные материалы с учетом требований проектов и применимых ГОСТ, а также поддерживать внутренние стандарты и шаблоны.

Чем предстоит дополнять контент продуктовой команды:

  • Писать и поддерживать пользовательскую, эксплуатационную и внутреннюю документацию
  • Описывать интерфейсы продукта: CLI, WebUI и gRPC API
  • Готовить документы по НИОКР и сопутствующие технические материалы

Что важно в способе работы:

  • Документировать как код (docs as code), чтобы материалы жили вместе с кодовой базой
  • Организованно собирать информацию и проверять ее вместе с разработчиками, тестировщиками и другими экспертами
  • Следить за актуальностью документов по графику выпусков продукта

Что мы предлагаем:

  • Гибкий график
  • Возможность удаленной работы, гибридного формата или работы из офиса
  • ДМС со стоматологией
  • Льготы и преимущества работы в аккредитованной ИТ-компании
  • Оформление по ТК РФ
Навыки
Техническая документацияПользовательская документацияdocs as codeGitLinuxAsciiDocAPI DocumentationOpenAPIgRPCProtocol BuffersНИОКРГОСТСистемы хранения данных

Обязанности

  • Разрабатывать руководства по установке и администрированию
  • Готовить инструкции по диагностике и примечания к релизам
  • Совместно с разработкой и тестированием актуализировать документацию по CLI, WebUI и gRPC API
  • Добавлять в документацию примеры команд, запросов, ответов и конфигураций
  • Готовить и поддерживать описания API в формате OpenAPI
  • Помогать разработчикам и архитекторам с материалами по архитектуре: тексты, технические схемы и диаграммы
  • Готовить техническую и отчетную документацию для НИОКР с учетом применимых ГОСТ и внутренних стандартов
  • Участвовать в подготовке технических описаний и исходных материалов для патентных заявок: схемы и сопроводительные материалы
  • Проверять документацию, примеры и пользовательские сценарии перед релизом и участвовать в ревью изменений
  • Разрабатывать и актуализировать шаблоны, правила оформления и требования к качеству документации
  • Участвовать в подготовке дизайн-документов и внутренних справочных материалов для продуктовых команд

Условия

  • Гибкий график
  • Удаленная работа, гибрид или работа из офиса (Санкт-Петербург, Приморская, Наличная улица, 44к1)
  • ДМС со стоматологией
  • Льготы и преимущества работы в аккредитованной ИТ-компании
  • Оформление по ТК РФ

Похожие вакансии

Как получить эту работу — с ИИ-помощником РаботаМакс

Бесплатно поможем на каждом шаге. Нажмите, чтобы раскрыть.