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

В продуктовую команду Shvacher открыта вакансия технического писателя.

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

Документацией пользуются системные администраторы и инженеры, специалисты технической поддержки и команды разработки. Техническому писателю предстоит работать с пользовательской, эксплуатационной и внутренней документацией, описывать CLI, API и WebUI, а также готовить документы для НИОКР.

Чего мы ждем:

• Опыт разработки технической документации для программного обеспечения или программно-аппаратных комплексов от 3 лет;
• Опыт документирования CLI, API и WebUI;
• Уверенная работа с Linux и командной строкой;
• Опыт работы с Git;
• Опыт работы по подходу Docs as Code;
• Умение самостоятельно собирать и проверять информацию, работать с разработчиками, тестировщиками и другими техническими экспертами;
• Умение планировать работу с учетом графика выпусков продукта и поддерживать документацию в актуальном состоянии;
• Умение писать ясные и структурированные технические тексты на русском языке;
• Английский язык на уровне, достаточном для чтения и подготовки технических текстов.

Чем предстоит заниматься:

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

Будет плюсом:

• Опыт документирования систем хранения данных, инфраструктурного программного обеспечения или программно-аппаратных комплексов;
• Опыт работы с Protocol Buffers, gRPC и OpenAPI;
• Опыт документирования REST API;
• Опыт подготовки документации для НИОКР и знание применимых стандартов;
• Опыт участия в подготовке технических описаний, схем и других исходных материалов для патентных заявок;
• Опыт работы с AsciiDoc.

Мы предлагаем:

• Гибкий график и возможность работать удаленно, в гибридном формате или из офиса;
• ДМС со стоматологией;
• Льготы и преимущества работы в аккредитованной ИТ-компании;
• Оформление согласно ТК РФ.