Шаблон описания технического писателя/Краткое описание

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

Профиль работы технического писателя

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

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

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

Отчеты

  • Главный технический директор
  • Менеджер по маркетингу
  • Старший писатель технического контента

Обязанности технического писателя

  • Создайте подробную документацию, которая соответствует корпоративным требованиям
  • Разработать тщательное понимание товаров и услуг для преобразования сложной информации о продукте в четкую, отполированную и интересную письмо
  • Создайте удобный контент, который удовлетворяет требованиям целевой аудитории, преобразуя понимание языка, который продвигает наших пользователей вперед
  • Создание и управление тщательными базами данных о справочных материалах, включая исследования, тестирование юзабилити и стандарты проектирования
  • Оценить текущее содержание и разработать новые методы улучшения
  • Проведение исследований, наброски, создания и редактирования новых и существующих материалов, сотрудничая с другими отделами, чтобы понять цели проекта
  • Соберите информацию от экспертов по предметам независимо для создания, организации и производства руководств по процедуре, технических спецификаций и процесса документации
  • Сотрудничать с разработкой и поддержкой приводит к определению всех хранилищ документации, переписывания и внесения изменений в существующую документацию и определить оптимальный вариант для сборки данных и централизованного хранилища
  • Исследовать, разрабатывать и управлять шаблонами информационной архитектуры, которые придерживаются организационных и нормативных норм, обеспечивая легкое движение данных
  • Создать материал в различных форматах медиа для оптимального использования при сохранении постоянного и последовательного голоса во всех документах

Требования и навыки технического писателя

  • BA/BS в технической коммуникации или аналогичной области, или не менее пяти лет опыта создания сложной документации для веб-технологий
  • Отличные способности письма, производства и технического редактирования
  • Отличные аналитические способности, а также способность работать на быстро меняющемся рабочем месте с изменяющимися потребностями и приоритетами проекта
  • Сильные навыки общения и сотрудничества, а также желание и способность сотрудничать с экспертами по вопросам инженерии, поддержки и управления продуктами
  • Работать и/или писать образцы в портфолио
  • Предыдущий опыт со следующими инструментами предпочтительнее: Confluence/Jira, Git и Github, HTML, CSS, Jinja, JavaScript, Python, Intercom и Mixpanel
  • Опыт работы с документацией API для отдыха или .NET API
  • Опыт работы и тестирование образцов кода, чтобы лучше понять требования клиентов API
  • Тщательное понимание вспышки Madcap
  • деталь, ориентированные с творческим взглядом
  • Способность своевременно и тщательно отвечать на комментарии на опубликованную информацию как от клиентов, так и от сотрудников внутренней поддержки
  • в восторге от обучения и развития
  • наслаждается работой в совместной обстановке как часть команды
  • Знакомство с программным обеспечением для публикации документации (Madcap, Robohelp, на основе вики)
  • Воздействие программ технологий коммуникации