Инженер базы знаний по открытым API

Что предстоит делать

Ассоциаций развития финансовых технологий открывает новую вакансию в Центре компетенций по открытым API. База Знаний АФТ- wiki.opendatarussia.ru Ценность роли: Построение, развитие и автоматизация Базы Знаний и MVP Портала Разработчика. Создание автоматизированной и масштабируемой платформы для внутренних и внешних участников. Полная ответственность за сопровождение жизненного цикла документации: от системной автоматизации (Docs-as-Code, Spec-as-Code) до финальной редакторской вычистки, верстки и сборки безупречных артефактов для передачи на Экспертный Совет, в Банк России. Ключевое взаимодействие: 1) С Руководителем (Владельцем стандартов): Оперативная синхронизация по приоритетам, превращение бизнес, нормативных требований в понятный технический бэклог развития Базы Знаний и платформы. 2) С Архитекторами: Совместное проектирование экосистемы для поддержки API-контрактов, моделей данных, структуры OpenAPI-спецификаций, правила валидации и тестов. 3) С системными и бизнес-аналитиками: Поддержка единых шаблонов, стандартизация описаний, автоматическая генерация документации в целевых форматах (HTML, MD, DOCX, PDF). 4) С руководителем проектов: размещение необходимых гайдов, инструкций, материалов по требованиям участников пилота. Основные обязанности и зоны ответственности 1. Автоматизация CI/CD и инфраструктура документации (Docs-as-Code) • Развитие и поддержка подходов Docs-as-Code & Spec-as-Code: проектирование и настройка автосборки, валидации и публикации документации/спецификаций через Git / CI/CD pipelines. • Автоматизация контроля качества (автоматическая проверка синтаксиса OpenAPI/AsyncAPI, линтинг, проверка ссылок, структуры и верстки). • Настройка и поддержка генераторов документации (Swagger/Redoc, Static Site Generators — MkDocs/Docusaurus/Hugo/Backstage, Pandoc/AsciiDoc). Поддержка инструментов OpenAPI CLI, Redocly, PlantUML/Mermaid. • Интеграция Базы знаний с реестрами компонентов, API-шлюзами и внешними порталами. 2. Архитектура и управление Базой Знаний • Проектирование и развитие целевой структуры внутренней и внешней Базы Знаний (стандарты открытых API, навигация, онбординг, FAQ, гайды, архитектурные принципы, обучающие материалы, материалы для команды и прочее). • Поддержание и развитие документации по OpenAPI на обзорном, функциональном, техническом и бизнес-уровнях. • Создание и поддержание единого понятийного аппарата: глоссарии, справочники, единые профили спецификаций и шаблоны. • Построение процессов управления жизненным циклом контента (актуализация, депрекация, версионирование, релиз-менеджмент). • Автоматизация сбора обратной связи от пользователей экосистемы (разработчиков, аналитиков, участников рынка) для непрерывного улучшения Базы Знаний. 3. Системный контроль качества • Разработка и внедрение правил, регламентов и Style Guides (по неймингу, проектированию и документированию API). • Полная предрелизная проверка спецификаций и технических стандартов (структура, орфография, пунктуация, верстка, единообразие, консистентность полей и реестров). • Финализация и подготовка эталонных комплектов: вычистка, верстка и сборка итоговых нормативных пакетов материалов перед передачей руководителю, Экспертному совету, Банку России и внешним участникам рынка. (сведение правок, таблицы соответствий и версий, релиз-ноутсы). • Автоматизированный аудит консистентности и качества артефактов (структура, бизнес- и технические слои, реестры). • Настройка аналитики и метрик Базы знаний (полнота, актуальность, частота обращений, узкие места). 4. MVP Портала Разработчика • Метамодель и Каталог (e-Catalog): Поддержка структурированной метамодели (сущности, атрибуты, descriptor-файлы) и единого каталога всех проектов, API и компонентов. • Трассируемость и Граф связей: Настройка и поддержка сквозного графа зависимостей (Нормативное требование → OpenAPI-операция → Правило валидации → Архитектурный компонент → Тест-кейс). • Quality Gates & CI/CD: Автоматизация проверок в пайплайнах (линтер OpenAPI, валидация JSON Schema, проверка уникальности ID, поиск битых ссылок и незакрытых требований). • Управление версионированием : Сборка, валидация и управление версионными срезами платформы (Baseline), проведение анализа влияния изменений (Impact Analysis). Hard Skills • Docs-as-Code & CI/CD: • Уверенное владение Git (стратегии ветвления, PR/MR, тэгирование релизов). • Отличное владение: Markdown, YAML, HTML/CSS, опыт работы с Pandoc / AsciiDoc для генерации точных PDF/Word документов. • Опыт настройки CI/CD процессов (GitLab CI, GitHub Actions или аналоги) для валидации и автопубликации контента. • Понимание работы генераторов статических сайтов (MkDocs / Docusaurus / Hugo / Antora/ Backstage) и инструментами Swagger/Redoc. • API & Форматы данных: • Глубокое понимание спецификаций OpenAPI (Swagger), AsyncAPI, JSON Schema, YAML/JSON. • Понимание базовых принципов REST, event-driven архитектуры и интеграционных стандартов. • Опыт работы с линтерами спецификаций (Redocly CLI, Spectral или аналоги). • Опыт разработки и ведения регламентов, методологии и Style Guides по документированию API. • Инженерия знаний и работа с контентом: • Навыки архитектуры информации (Information Architecture) — умение логически структурировать сложнейшие технические домены. • Базовые навыки программирования (Python, TypeScript/Node.js или Go) для написания кастомных скриптов сборки, парсеров и валидаторов. • Желателен опыт работы с инструментом визуализации (PlantUML, Mermaid, Structurizr, C4 model). Soft Skills • Инженерный подход и стремление к автоматизации: поиск способов автоматизировать проверки и рутинные сборки. • Исключительная внимательность к деталям и аккуратность • Системность и продуктовое мышление: Восприятие Базы Знаний и Стандартов как внутреннего продукта, оценка его удобства для инженеров и бизнеса (Developer Experience). • Автономность и инициативность: Умение самостоятельно утилизировать верхнеуровневую постановку задачи с конкретным результатом, спроектировать техническое решение и довести его до внедрения без постоянного микроменеджмента. • Способность агрегировать требования и правки от директора, руководителя, архитекторов, аналитиков, руководителя проектов, участников пилотов, приводя их к единому стандарту

Что предлагаем