Технический писатель (enterprise / системная документация)
Коротко
Develops and maintains system documentation for treasury/ERP systems, including admin guides, user manuals, integration descriptions, and runbooks, following · Needs: 3+ years as technical writer, 2+ in IT system documentation; understanding of client-server, microservices, Docker, and PostgreSQL; basic network and security
Описание от работодателя
Предметная область
Разработка и внедрение корпоративных информационных систем класса казначейство/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, Kerberos/AD, SSH, сертификаты X.509, межсетевые экраны и сегментация сети (DMZ), понятия НСД, аудита, парольной политики.
Опыт чтения технических артефактов: OpenAPI/Swagger, JSON/XML/CSV, docker-compose.yaml, .env-шаблоны, схемы инфраструктуры (Draw.io, PlantUML).
Работа в Linux-командной строке на уровне воспроизведения процедур: psql, docker, curl, ssh.
Самостоятельная добыча информации: интервьюирование инженеров, анализ логов и кода, воспроизведение сценариев на стенде — без блокировки при недоступности эксперта.
Грамотный письменный русский язык, нормативно-деловой стиль (ГОСТ, технические регламенты), умение структурировать сложный материал.
Уверенное владение Word (стили, нумерация, перекрёстные ссылки, оглавление) и Markdown; опыт систем ведения документации (Confluence, Git + docs-as-code — плюс).
Будет плюсом (nice-to-have)
Опыт документирования корпоративных систем: казначейство, финансовый/банковский домен, ЭДО, интеграции с банками host-to-host, СЭД.
Знакомство с ГОСТ 34-й серии, ГОСТ Р 59853-2021, корпоративными стандартами документирования.
SQL на уровне диагностических запросов; понимание репликации и резервного копирования (pg_probackup).
Понимание CI/CD, Git; docs-as-code (Asciidoc, MkDocs).
Опыт подготовки материалов для аттестации/сертификации ИС по требованиям защиты информации (ФСТЭК).
Личностные качества
Системное мышление: выстроить целостную картину продукта из фрагментов знаний разных команд.
Высокая самостоятельность: доводит документ до состояния «готово к утверждению» без постоянного надзора.
Умение задавать точные вопросы и выстраивать коммуникацию с разработчиками, администраторами и ИБ-специалистами.
Внимательность к деталям: команды, пути, имена хостов, параметры конфигурации — документ читается как инструкция к действию.
Управление приоритетами: синхронизация документации с релизным циклом.