Помогаю разобраться в продукте без помощи разработчика

Севара Ахтямова

Обучаю команды писать документацию и автоматизирую её проверку

Диадок · Универсальный модуль

Описала 116 методов модуля Диадока

Интеграторы находят нужный метод по своей задаче: справка разделена по функциям модуля.

Разработчикам больше не нужно писать справочные статьи с нуля. Я готовлю текст, они проверяют техническую точность.

Полезность документации оценили на 8 из 10 — на 2 балла выше, чем у смежных отделов.

Автоматизация · 2025–2026

Сократила проверку документации с 17 до 4 часов с помощью ИИ

Провела исследование ИИ-моделей нескольких компаний на реальных задачах проверки документации. Протестировала разные запросы и способы сверки.

Написала собственный плагин и применила его для проверки структур формата 970. Его можно использовать повторно при обновлении документации.

Севара Ахтямова
Севара Ахтямова. Технический писатель в Контуре.

База знаний · 2023–2024

Реорганизовала 800 страниц базы знаний команды

Коллеги стали находить ответы в базе без помощи разработчиков. Это сократило повторные вопросы.

Новые сотрудники получили инструкции для самостоятельного выполнения типовых задач. Наставникам больше не нужно объяснять каждому один и тот же порядок действий.

Команда перестала тратить время на сверку разных версий документов: в базе остались актуальные инструкции.

Сама инициировала изменения и стала администратором базы. Исправления и дополнения поступают ко мне — коллегам не нужно искать автора страницы, чтобы обновить материал.

Обучение команды и работа с документацией

УрФУ · ФИИТ · 2023–2025

Преподавала техническую редактуру

Участвовала в разработке курса «Редактура в IT. Техническая документация»: готовила материалы, проводила лекции и проверяла работы студентов.

Во втором цикле подготовила две лекции и помогала на четырёх занятиях.

Передача знаний · 2023–2024

Научила команду выпускать документацию

Подготовила инструкции по сопровождению документации EDI и Универсального модуля.

Проверила их на практике: разработчик самостоятельно опубликовал документацию к релизу по инструкции.

Работа с командой · 2025–2026

Мастер-класс и менторство для аналитиков

На примерах постановок задач выявила повторяющиеся проблемы в текстах. Провела мастер-класс с практикой и материалами для самопроверки.

Стала временным ментором двух аналитиков и проводила индивидуальные ревью постановок.

Поиск и обратная связь · 2022–2023

Восстановила поиск в документации

Читатели находят нужную статью по запросу внутри справки. Документация Диадока и EDI также открыта для индексации — материалы можно искать через внешние поисковые системы.

Через форму обратной связи читатели могут сообщить об ошибке или запросить недостающее пояснение.

Рабочие инструменты

Тексты и сборка
Markdown · reStructuredText · AsciiDoc · Sphinx · Read the Docs
Совместная работа
GitLab · GitHub · VS Code · YouTrack
Исследования
Яндекс Метрика · опросы · интервью