Технический писатель (enterprise / системная документация)

Предметная область

Разработка и внедрение корпоративных информационных систем класса казначейство/ERP для крупного холдинга: микросервисная архитектура, Docker, PostgreSQL, Valkey, интеграции по REST и файловому обмену, инфраструктура Active Directory, строгие требования информационной безопасности. Документация разрабатывается в соответствии с ГОСТ Р 59853-2021 и корпоративными стандартами оформления.

Задачи

• Самостоятельно (с консультациями архитекторов, разработчиков, DevOps и администраторов БД) разрабатывать и актуализировать: руководства администратора (установка, настройка, эксплуатация, мониторинг, аварийные процедуры); руководства пользователя и Куратора ИБ; описания интеграционных взаимодействий (API, файловый обмен, форматы данных); регламенты эксплуатации, runbook'и, чек-листы развёртывания и отката; описания нового функционала к релизам.

• Систематизировать разрозненные знания команды: интервьюировать инженеров, анализировать конфигурации, compose-файлы, переменные окружения, схемы БД, журналы, код репозиториев.

• Проверять документы «руками» на тестовом стенде: проходить по шагам процедуры и убеждаться, что всё воспроизводится.

• Вести единую терминологию и глоссарий, соблюдать требования ГОСТ и внутренних стандартов оформления.

• Участвовать в приёмке релизов: проверять соответствие реализации описанным процедурам.

Требования (must-have)

• Опыт технического писателя от 3 лет, из них не менее 2 лет — документация ИТ-систем в эксплуатацию (административные руководства, runbook'и, инструкции по развёртыванию).

• Уверенное понимание программной и системной архитектуры: клиент-серверная модель, микросервисы, контейнеризация (Docker, Docker Compose, systemd), отказоустойчивость (Primary-Replica, кворум, Sentinel), кэш-слои (Redis/Valkey), очереди сообщений.

• Знание СУБД на уровне чтения схем и составления простых SELECT-запросов (PostgreSQL или аналог): таблицы, представления, миграции, роли и ТУЗ.

• Базовые знания сетей и ИБ: TLS/HTTPS…