Платформа документации

Специфика нашей работы

Мы занимаемся разработкой программной платформы документации в парадигме documentation as a code.

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

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

Концепция documentation as a code предполагает, что написание документов следует принципам написания кода, целью которых является создание четкой структуры для легкого понимания и чтения.

Минимум верстки

В плане интерфейса документация - простой сервис.

Основные интерфейсные компоненты мы берем из open source библиотеки @gravity-ui/uikit.

Для сложного пользовательского контента мы предоставляем интеграцию с @gravity-ui/page-constructor.

Максимум логики

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

Важно не теряться в инкрементах циклов, не создавать излишней вложенности, умело выбирать структуры данных.

Сервера

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

Основные технологии с которыми мы работаем на серверах:

Со всеми перечисленными технологиями мы работаем лично. Следим за стабильностью серверов. Прорабатываем архитектуру. Выстраиваем процессы для обеспечения стабильности.

OpenSource

Большая часть нашей платформы размещена в open source.

Поддержка open source является важной частью нашей ежедневной работы:

• Общение в issues и pull requests в GitHub на русском и преимущественно английском языке.
• Презентация/продвижение продукта на разных конференциях и митапах.
• Разработка продукта не под конкретную компанию, а под совокупный опыт/ожидания сообщества.

Ожидания от кандидата

Мы ожидаем что вы уже знаете или вам было бы интересно быcтро изучить:

Алгоритмы и структуры данных

Ничего экзотического не требуется. Но в базовых нужно разбираться хорошо. Умело их применять.

Отдельным плюсом будет, если вы сталкивались с алгоритмами токенизации текстов, разбираетесь в алгоритмах поиска по текстам.

Потому что мы разбираем тексты на кусочки, а потом собираем из них что-нибудь новое и прекрасное.

Серверные архитектуры

Потому что мы много работаем с серверами

Форматы

CommonMark спецификаци маркдауна.

GitHub Flavored Markdown спецификаци маркдауна.

JSONSchema - работаем со схемами чаще среднестатистического разработчика

Open Source технологии

Git - чуть глубже чем просто создание коммитов. Мы используем его на программном уровне.

GitHub - так же глубоко интегрирован в наш продукт. Пишем gh-actions, gh-extensions дл внешних потребителей платформы документации.

Webpack - на уровне написани собственных плагинов.

Литература

Мы будем лучше друг друга понимать, если вы уже читали:

Чистый код Роберта Мартина

Чистая архитектура Роберта Мартина

Site Reliability Engineering Бетси Бейер и др.

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