Технический писатель • Docs-as-Code • B2B SaaS

Содержание#

Обо мне#

Технический писатель с опытом работы в продуктовой разработке B2B SaaS. Проектирую и сопровождаю документацию как часть инженерного процесса: от архитектуры и Docs-as-Code до пользовательских руководств, API-документации и внутренних баз знаний. Люблю разбираться в сложных технических системах и помогать командам превращать накопленные знания в удобную и поддерживаемую базу знаний.

Ключевые компетенции#

  • Пользовательская документация
  • Документация для разработчиков
  • API-документация
  • Docs-as-Code
  • Архитектура документации
  • Базы знаний
  • Release Notes
  • Информационная архитектура
  • UX-редактура
  • Локализация документации (RU/EN)

Практический опыт#

Docs-as-Code#

  • Git как основной способ сопровождения документации.
  • Работа с feature-ветками, Merge Request и Pull Request.
  • Code Review документации.
  • Версионирование документации.
  • Выпуск документации синхронно с релизами продукта.

Архитектура документации#

  • Проектирование структуры документации.
  • Diátaxis.
  • Навигация.
  • Стайлгайды.
  • Шаблоны документации.
  • Организация внутренних баз знаний.

Работа с командами#

  • Интервью с разработчиками и аналитиками.
  • Уточнение требований.
  • Совместная работа с DevOps и Product Owner.
  • Наставничество младшего технического писателя.
  • UX-редактура документации.

Анализ и расследование проблем#

  • Воспроизведение пользовательских сценариев.
  • Проверка REST API.
  • Анализ логов и конфигурации.
  • Подготовка технических баг-репортов.
  • Локализация причин ошибок.
  • Диагностика проблем производительности совместно с разработчиками.

Инструменты и технологии#

Linux#

Уровень: базовый

Опыт: с 2021 года

Использую для:

  • работы с Ubuntu Desktop и Ubuntu Server;
  • настройки VPS;
  • управления пользователями и SSH-доступом;
  • настройки Nginx и UFW;
  • работы с systemd и журналами;
  • диагностики сетевых проблем;
  • работы с CLI-инструментами;
  • развёртывания статических сайтов.

Git#

Уровень: уверенный

Опыт: с 2023 года

Использую для:

  • Docs-as-Code;
  • feature-веток;
  • Merge Request / Pull Request;
  • Code Review;
  • rebase;
  • cherry-pick;
  • разрешения merge-конфликтов;
  • сопровождения релизов документации.

Docker#

Уровень: базовый

Опыт: с 2024 года

Использую для:

  • локальной сборки документации;
  • подготовки Dockerfile;
  • переноса легаси-проекта документации на инфраструктуру компании;
  • воспроизводимого окружения разработки.

REST API#

Уровень: уверенный

Инструменты: Postman, Insomnia

Использую для:

  • проверки REST API;
  • подготовки примеров запросов;
  • анализа запросов и ответов;
  • воспроизведения пользовательских сценариев;
  • диагностики проблем при подготовке документации и работе в технической поддержке.

SQL#

Уровень: базовый

СУБД: MySQL

Использовала для:

  • анализа данных;
  • расследования обращений пользователей;
  • локализации проблем;
  • проверки состояния объектов в базе данных;
  • воспроизведения ошибок.

Генераторы статических сайтов#

Docusaurus + Markdown#

Уровень: уверенный

Использовала для:

  • запуска пользовательского портала документации с нуля;
  • проектирования структуры документации;
  • публикации документации;
  • сопровождения релизов продукта.

Sphinx + reStructuredText#

Уровень: уверенный

Использовала для:

  • пользовательской документации;
  • документации для разработчиков;
  • Release Notes;
  • Changelog;
  • сопровождения легаси-проекта документации.

Hugo#

Уровень: базовый

Использую для:

  • разработки личного сайта-портфолио;
  • публикации технического блога;
  • кастомизации темы и структуры сайта.

Редакторы#

Основной редактор: VS Code

Дополнительно:

  • Vim — редактирование файлов на Linux-серверах;
  • Nano — быстрые изменения конфигурационных файлов.

Дополнительные инструменты#

Использую в работе:

  • Jira
  • Confluence
  • GitHub
  • GitLab
  • Figma
  • ShareX

Также имею опыт работы с:

  • PHP (чтение и небольшие модификации кода);
  • Smarty;
  • CSS;
  • React (небольшие кастомизации Docusaurus);
  • ChatGPT (поиск причин ошибок сборки, “метод резиновой уточки”).

Проекты#

Портал документации Геомикс 2.0#

  • Архитектура документации.
  • Docusaurus.
  • Docs-as-Code.
  • Diátaxis.

Миграция легаси-документации#

  • Анализ существующей сборки.
  • Подготовка Dockerfile.
  • Перенос проекта на инфраструктуру компании.
  • Настройка воспроизводимой сборки.

Примеры публикаций#

Сайт-портфолио#

  • Hugo.
  • Git.
  • Linux VPS.
  • Nginx.

(Планируется описание процесса развёртывания и сопровождения.)

Опыт работы#

…

Образование#

…