Регулярно готовила User guide, Admin guide и release notes для коммерческих продуктов на русском и английском языках. Ниже примеры моих работ в открытом доступе.
Содержание
- Проектирование пользовательской документации с нуля для Геомикс 2.0
- Устранение инфраструктурного риска легаси-документации
- Построение Docs-as-Code инфраструктуры для личного проекта netnotes.xyz
Проектирование пользовательской документации с нуля для Геомикс 2.0
Задача
Разработка и развитие системы пользовательской документации для инженерного ПО. Целевая аудитория документации: инженеры буровзрывных работ, маркшейдеры.
Что сделала
- Выявила требования к пользовательской документации через интервью со стейкхолдерами и специалистами внедрения.
- Проектирование структуры документации с нуля.
- Проектирование информационной архитектуры.
- Подготовка контента по принципам Docs-as-Code.
- Настройка процессов разработки документации.
Использовалось: Docusaurus, Markdown, Git, Docs-as-Code, Diátaxis.
Результат
- Создана масштабируемая структура документации.
- Документация переведена в формат, удобный для совместной разработки.
- Подготовлена база для дальнейшего развития продукта.
Устранение инфраструктурного риска легаси-документации
Документация продукта размещалась на стороннем частном хостинге, срок обслуживания которого подходил к концу. При этом проект представлял собой легаси-сборку с большим количеством зависимостей и практически без документации по развёртыванию. Это создавало риск потерять возможность обновлять и публиковать документацию после отключения хостинга.
Задача
Контейнеризация легаси-сборки документации для последующей миграции на корпоративную инфраструктуру.
Что сделала
- Обнаружила критическую зависимость документации от стороннего хостинга и инициировала её миграцию на инфраструктуру компании.
- Совместно с DevOps разработала план миграции на корпоративную инфраструктуру.
- Проанализировала зависимости проекта и текущую сборку.
- Подготовила Dockerfile с учётом устаревших зависимостей и особенностей сборки.
- Проверила воспроизводимость сборки в контейнере и устранила возникшие проблемы.
- Подготовила контейнер для интеграции в корпоративный CI/CD.
Результат
В результате документация перестала зависеть от стороннего хостинга, получила воспроизводимую сборку и автоматизированный процесс развёртывания. Проект стал частью стандартной инфраструктуры компании.
Построение Docs-as-Code инфраструктуры для личного проекта netnotes.xyz
Персональный проект, в котором самостоятельно развернула инфраструктуру для статического сайта: VPS, nginx, HTTPS, GitHub Actions, автоматический деплой и сопровождение сервера.
Что сделала
- Настроила VPS на Ubuntu Server.
- Развернула Hugo на VPS (Ubuntu Server).
- Адаптировала тему Terminal под свои задачи.
- Использовала Git submodules для управления темой Hugo.
- Настроила nginx и HTTPS.
- Настроила GitHub Actions для автоматического деплоя при изменениях в основной ветке.
- Разделила пользователей сервера, создала отдельного для деплоя.
- Минимальный харденинг сервера.
Инструменты и технологии
- Hugo Extended
- Markdown
- Git
- GitHub Actions
- nginx
- Ubuntu Server
- Let’s Encrypt
- rsync
- SSH deployment
Сейчас изучаю
- Администрирование Linux серверов.
- Контейнеризацию и Docker.
- Автоматизацию развёртывания и сопровождения Docs-as-Code проектов.
- Мониторинг собственной инфраструктуры с помощью Prometheus.