Как оцениваем большие проекты, организовываем работу с техписателями и заказчиками, с какими сложностями сталкиваемся и как подводим итоги Текст как проект Анастасия Писнова Младший технический писатель

Анастасия Писнова apisnova@ozon.ru Отдел технической документации и UX-редактуры Младший технический писатель Пришла в Ozon после прошлогоднего митапа Поддерживаю покупательскую Справку Готовлю переводы Справки на английский язык Причёсываю ответы чат-ботов Раньше работала с ГОСТами

3 Техписы бывают разные ГОСТовские техписатели Ориентир на ГОСТы и требования нормоконтроля Небольшая аудитория документации Документация обычно ведётся в Word Продуктовые техписатели Ориентир на внутренние стайлгайды и best practices коллег Большая аудитория документации Для документации используют разное ПО: Confluence, IDE, DITA

4 Однажды в команду пришла большая задача

5 Однажды в команду пришла большая задача

6 Однажды в команду пришла большая задача Выкатываемся через 1,5 месяца

7 Эпик — как задача, только больше и со своими метриками

8 Единый процесс Стейкхолдеры Загрузка команды Сроки Вычитки Инструменты Размер рабочей группы А ещё URL красивый сделать надо Сбор требований

9 Этапы эпика 01 02 04 03 Уточнить вопросы у заказчика Сделать структуру будущей доки Показать структуру рабочей группе и лиду Показать структуру заказчику 05 06 Распределить задачи в рабочей группе Создать задачи на статьи или разделы Договориться о последовательности работ и выкатки Сделать задачи, обновить статусы Провести демо заказчику Внести доработки и выкатить на прод Провести демо на всех техписателей 07 Провести ретро с рабочей группой 08 09 10 11 12

10 Процессы эпика Уточнить вопросы у заказчика • сроки • тексты от продукта • макеты • ✨definition of done✨ Согласовать приоритеты выкатки • сроки выкатки продукта • приоритеты статей и разделов Сделать структуру и согласовать с заказчиком и рабочей группой • главная страница • разделы и их содержание Создать и распределить задачи на рабочую группу • распределение ролей и нагрузки на группу по спринтам • roadmap • задачи на вычитки и релиз

11 Процессы эпика Сделать задачи, вычитать и обновить статусы • черновики • внутренняя вычитка • согласование с заказчиком Провести демо заказчику • итоговые сроки выкатки • фидбек от заказчика • финальные правки Провести демо рабочей группе и другим техписателям • итоговый черновик со всеми статьями • сбор фидбека с коллег Выкатить на прод • красивый адрес для документации, если нужно: не 123456.prod.ru, а seller-api.prod.ru • 🎉релиз🎉

12 Ретро 1. Подводим итоги работы 2. Анализируем, что было хорошо, а что не очень 3. Думаем, какие штуки можно применять в следующих эпиках 4. Показываем ретро остальной команде А ещё это отличная возможность поблагодарить уважаемых коллег

13 Плюсы процесса 01 Единый процесс для всех 02 Визуализация этапов 03 Процесс — база знаний 04 Работа над ошибками

14 Статистика по эпикам 38 закрыли 7 в процессе

15 Аудитория эпиков 22 000 чел. посетило Справку для других стран на русском языке за 4 месяца 8000 чел. посетило Справку для других стран на английском языке за 4 месяца >19 000 просмотров Справки Ozon Банка для бизнеса после переноса 23 000 раз посмотрели документацию разработчиков после рефакторинга нашими силами

16 Что может пойти не так?

17 ВСЁ

18 Проблемы и их решение Коллега из рабочей группы заболел или занят более приоритетными задачами Заранее заложить в сроки занятость коллеги. Если это уже случилось — передать задачи другим членам рабочей группы или привлечь кого-то из коллег

19 Проблемы и их решение Заказчик не выходит на связь и затягивает с вычиткой Писать заказчику везде, где только можно, и привлекать лидов. Если ничего не помогает — переводим эпик на холд и снимаем приоритет

20 Проблемы и их решение Пришёл ранее неизвестный стейкхолдер и принёс кучу правок • Собраться рабочей группой, заказчиками и стейкхолдером и проанализировать правки • Согласовать итоговый список правок и внести их

21 Проблемы и их решение Выкатка перенеслась из-за форс-мажора Переносить выкатку эпика. Если выкатка постоянно переносится, а тексты уже готовы — снять приоритет

22 Проблемы и их решение «Сделайте всё ASAP» • Понять, откуда сроки • Показать заказчику roadmap работ, объяснить, что есть объективные причины, почему не успеем • Выкатывать задачи постепенно

23 Проблемы и их решение Изначальная структура запутанная, команде сложно собрать новую Привлечь лидов или старшего техписа не из рабочей группы

24 Проблемы и их решение Заказчик категорически не одобряет новую структуру • Разобраться, что именно не устраивает • Аргументировать, почему сделали именно так • Оперировать стайлгайдами и предыдущими похожими эпиками

25 Проблемы и их решение Если вдруг после выкатки упал прод с документацией… Откатиться и проанализировать, почему упал прод. Если есть возможность, проверить релиз на стадии его сборки

26 Советы, которые сэкономят время и нервы Не пренебрегайте анализом вводной информации. Чем раньше вы узнаете, что чего-то не хватает, тем меньше времени потратите на ожидание Сразу проверьте, что у вас и остальной рабочей группы есть все необходимые доступы При оценке сроков учитывайте время на вычитку коллегами и заказчиками, приёмку, а также отпуска и периоды высокой нагрузки у рабочей группы Лишний раз убедитесь, что заказчики согласовали работы над проектом со своими руководителями и юристами

Есть вопросы? Давайте обсудим! Анастасия Писнова Младший технический писатель