Technical writer

Дата размещения вакансии: 01.11.2024
Работодатель: Аренадата Софтвер
Уровень зарплаты:
з/п не указана
Город:
Санкт-Петербург
Требуемый опыт работы:
От 3 до 6 лет

Мы начинаем разработку нового open source проекта Greengage DB (собственного форка недавно ушедшего Greenplum) и ищем технического писателя, который будет создавать документацию для данного продукта.

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

С нашей текущей документацией можно ознакомиться на сайте docs.arenadata.io. В 2024 году наш сайт был номинирован на международную премию DevPortal Awards. Об истории развития портала документации в компании, а также внутренних процессах отдела технических писателей можно прочитать в нашем техническом блоге.

Что нужно делать:

Разрабатывать документацию нового open source проекта Greengage DB на английском и русском языках с использованием методологии docs-as-code (Antora + AsciiDoc).

Мы ожидаем, что вы:

  • имеете опыт написания различной технической документации на современные IT-продукты (пошаговые руководства, концептуальные статьи, описания UI, CLI, API).
  • готовы к глубокому изучению наших продуктов при поддержке со стороны наших технических менеджеров, архитекторов, системных аналитиков и разработчиков. Это включает развертывание и настройку тестовых стендов в облаке, установку всех необходимых сервисов, написание и запуск SQL-запросов, а также кода на других языках программирования.
  • способны проводить самостоятельное тестирование описываемого функционала, выполняя все описываемые в документации шаги.
  • имеете опыт работы с системами контроля версий (GitHub/GitLab).
  • являетесь опытным пользователем Linux либо хотите развиваться в этом направлении.
  • знакомы по крайней мере с одним из SSG-движков (Antora, Sphinx, Hugo, Gatsby и др.) и/или языком разметки текстов (AsciiDoc, reStructuredText, Markdown и др.).
  • понимаете базовые принципы работы CI/CD и имеете навыки работы с основными DevOps-инструментами, такими как Docker.
  • умеете писать документацию как на русском, так и на английском языках.

Будет здорово, если знакомы с основами СУБД и писали SQL-запросы.