Techscripsi
О себе
Квалифицированный технический писатель, DocOps. Занимаюсь написанием, сопровождением и техническим обслуживанием IT-документации.
- Описание сложных систем, в том числе создание документации с нуля.
- Docs-as-code: Git, SSG, легковесная разметка, автоматизация и интеграция с дополнительными инструментами.
- Работа с документируемым продуктом в тестовой среде: средства виртуализации, IDE, инструменты API.
- Миграция, реорганизация и приведение документации в порядок.
Дополнительно
- Организация процесса локализации (i18n), включая подбор инструментов.
- Создание системы единого источника.
- Подбор инструментов документирования и выбор вариантов развёртывания.
Профессиональные качества
- Высокий уровень технической осведомлённости.
- Быстрое погружение в новую предметную область.
- Адаптивность, желание изучать и применять новые инструменты и процессы.
Софт-скиллы
- Экологичное общение, учитываю обратную связь от собеседника.
- Онбординг и обучение новых сотрудников, участие в проведении собеседований.
- Взаимодействие с разработчиками, менеджерами продуктов, службой поддержки, аналитиками и дизайнерами — для создания консистентной и удобной документации.
Примеры документации
Ниже представлены примеры документации для разработчиков (Dev), администраторов (Admin) и пользователей (User), а также некоторые тестовые задания.
— Windows, — Linux, — на английском языке.- Dev
- Admin
- User
Тестовые задания
How to create a pivot table in excel
Pencil User Manual
Nimble Exporter README
Start Internet Explorer on Windows 10 (DITA)
Windows Notepad user guide
VK RuStore
Площадка для размещения мобильных приложений
- Документирование API/SDK, консоли разработчика и мобильного приложения RuStore.
- Миграция и реорганизация документации.
- Организация процесса локализации.
- Создание системы единого источника, интеграционные задачи.
КИБЕР-РОМ
Разработка высоконагруженных проектов, медиапроизводство, геймдев
- Документирование облачной платформы по обработке медиаданных — описание системы.
- Документирование API облачного видеохостинга.
- Работа в тестовой среде с API (Swagger) и брокером сообщений (Apache Kafka).
Проектная работа
Аладдин Р.Д.
Криптография, защита данных, защищённый доступ
- Создание комплекта документации инструментов защищённого корпоративного доступа для Linux.
- Работа в виртуальной среде: VMware vSphere.
Совинтегра
Комплексные решения по информационной безопасности
- Документирование и создание лабораторных работ для изучения инструментов защищённого корпоративного доступа.
- Работа в виртуальной среде: VMware vSphere.
- Перевод технической документации на английский язык.
Globus
Цифровые сервисы для крупного бизнеса
- Документирование системы доступа к банковской базе данных.
BPC/RBS
Финтех, платёжный шлюз
- Документирование платёжного шлюза: API, личный кабинет продавца.
- Работа с API в тестовой среде: Postman, SoapUI, Swagger.
- Создание внутренних документов и ведение базы знаний.
- Миграция документации.
- Перевод документации и координация работы удалённых переводчиков.
Аладдин Р.Д.
Криптография, защита данных, защищённый доступ
- Документирование инструментов защищённого персонального/корпоративного доступа и шифрования.
- Развёртывание инфраструктуры PKI в виртуальной среде: VM Ware.
- Локализация: создание и поддержка глоссариев и памяти переводов.
Docs-as-code
- VS Code, Notepad++.
- GitHub, GitLab, меньше — BitBucket.
- regEx.
- SSG — генераторы статических сайтов.
- CLI — утилиты командной строки.
- Mermaid — диаграммы в синтаксисе markdown.
- Pandoc.
Локализация
- Облачные решения: Phrase, SmartCat, WebLate.
- Автономные решения: OmegaT, Qt Linguist, Zeta Resource Editor.
- Интеграция с Git.
- Пред- и постобработка локализуемых файлов.
Виды документации
- Документация разработчика (API/SDK).
- Руководства пользователя.
- Руководства администратора.
- Руководства по обновлению и миграции.
- Быстрый старт.
- База знаний.
- Онлайн-справка.