Мы разрабатываем программное обеспечение и интегрированные решения для торгового оборудования: от кассовых систем и терминалов сбора данных до backend-сервисов и API для ритейла. Нам нужен технический писатель, который поможет превратить сложные технические решения в понятную, структурированную и актуальную документацию — для интеграторов, разработчиков и конечных пользователей.
Что вы будете делать:
- Писать и поддерживать техническую документацию: руководства пользователя, инструкции по установке и настройке оборудования, описания API, схемы интеграции;
- Работать с исходниками документации в формате reStructuredText (основной формат для Sphinx);
- Участвовать в сборке и публикации документации через Sphinx;
- Использовать Git и GitLab в повседневной работе: создавать ветки, отправлять merge request’ы, отслеживать изменения;
- Вносить правки в конфигурационные файлы GitLab CI/CD (.gitlab-ci.yml) — хотя бы на уровне понимания структуры и базовых задач (например, запуск сборки документации при пуше в ветку);
- При необходимости — корректировать или дополнять HTML-вёрстку сгенерированной документации (базовое понимание разметки приветствуется).
Мы ожидаем, что вы:
- Умеете уверенно работать с Git и GitLab;
- Знаете или готовы быстро освоить reStructuredText и Sphinx;
- Имеете представление о том, что такое .yml-файлы и как они используются в CI/CD (опыт с .gitlab-ci.yml — большой плюс!);
- Не боитесь смотреть в HTML и понимаете базовую структуру веб-страниц;
- Способны разобраться в технических деталях: как устроено ПО для торгового оборудования, как устроено ТО, как взаимодействует сканер, принтер и облачный сервис;
- Внимательны к деталям и умеете писать так, чтобы было понятно и инженеру, и администратору магазина.
Будет плюсом:
- Опыт работы с оборудованием (весы, сканеры штрихкодов, принтеры чеков и т.п.);
- Понимание принципов работы REST API, JSON, сетевых протоколов;
- Опыт документирования embedded-решений или промышленного ПО;
- Знакомство с другими системами генерации документации (MkDocs, Docusaurus и др.).
Мы предлагаем: