Технический писатель
Разработчик технической документации (Middle)
Ключевые навыки
Технический писатель
- Подготовка технической документации
- Вёрстка инструкций для разработчиков с использованием разметки Markdown
- Тестирование API-интеграций и подготовка документации по API
- Подготовка и публикация пользовательских release notes
- Связь release notes с технической документацией
- Написание технических статей и дайджестов для Хабр (пример 1, пример 2)
- Перевод технической документации
Кейсы
Автоматизация release notes
- Проблема
- Сбор release notes проводился вручную, из-за этого некоторые ключевые фичи терялись в общем потоке выпущенных обновлений и пользователи не знали о важных изменениях в продукте.
- Решение
- Благодаря настройке компонентов в Jira выгрузку release notes удалось автоматизировать, а также разбить все выпущенные фичи на блоки, что упростило работу с информацией об обновлениях.
- Результат
- Сбор release notes сократился с 2 часов до 2 минут. Это освободило время работы технического писателя и улучшило качество обработки фичей перед публикацией.
Разработка гайда по платежам
- Проблема
- Информация про обработку платежей в мобильных приложениях находилась в разных разделах документации. У разработчиков не было единой картины интеграции платежей, создания платных товаров и подписок, подключения API.
- Решение
- Решением стало создание единой страницы со сценарием использования платежей: от подключения монетизации мобильных приложений до настройки API и тестовых платежей.
- Результат
- Это улучшило пользовательский опыт разработчиков и сократило число обращений в поддержку.
Переход на Docusaurus
- Проблема
- На старте проекта RuStore документация велась в типовой CMS, что сильно ограничивало возможности технических писателей. В частности, возникали проблемы со вставкой code sample — примеры кода не всегда хорошо смотрелись в вёрстке, и разработчикам было сложно их применять на практике.
- Решение
- Чтобы исправить ситуацию, всю документацию перевели в Docusaurus, чтобы создавать инструкции с помощью разметки Markdown.
- Результат
- Это не только улучшило внешний вид текстов и вставок с примерами кода, но и позволило привлечь к созданию документации другие команды RuStore.
Мои результаты
6
завершённых проектов
- Миграция на Docusaurus
- API-документация
- Гайд по платежам
- Release notes
- Обновление метаданных
- Локализация документации
8
освоенных навыков
- Markdown-разметка
- Git
- VS Code
- LLM-агенты
- Техническая документация
- Анализ требований
- Figma
- Тестирование API
8
областей применения
- Software products
- Developer platforms
- APIs & integrations
- E-commerce platforms
- Mobile ecosystems
- Fintech & payments
- AI-powered products
- B2B enterprise systems
Работа с AI
Этот лендинг собран с помощью Claude Code — я использовала его для вёрстки, структуры и текстов страницы. При необходимости я работаю с AI для сбора и анализа данных, создания черновиков текстов, автоматизации рутины.
Анализ release notes
- Что и как использовала
- LLM-агент: анализировала release notes и просила выделить изменения, которые непосредственно влияют на пользовательский опыт.
- Какой результат получала
- Сокращала время на первичный анализ release notes и снижала риск пропустить значимые для пользователей изменения.
Локализация документации
- Что и как использовала
- Применяла LLM-агент для чернового перевода на английский + ручная проверка.
- Какой результат получала
- Более быстрая подготовка локализованной документации.
Ожидаемый уровень дохода
- Полная занятость — 180 000-200 000 рублей gross
- Частичная занятость — 120 000 рублей gross
- Разовый проект — от 50 000 рублей gross в зависимости от объёма работ