Мария Смирнова, Ozon
Управление знаниями при быстром росте компании
Исходные данные
- 400+ компонентов, 20 лет компании, большой объем знаний
- база знаний нужна для техподдержки, для новых разработчиков
Пошаговый план
- среда для базы знаний -> неактуальные знания -> стандарты и новые знания -> вовлечение разработчиков -> оценка качества документации
Шаг 0. Среда для базы знаний
- было confluence + gdocs + word. попробовали onebar и локальный stackoverflow. вернулись к confluence, чтобы не травмировать разработчиков
Шаг 1. Неактуальные знания
- было 22460 страниц, разбирали руками, осталось 10365 страниц, позже стало 12028. процесс замедлился, идеально актуального и чистого пространства не получилось
Шаг 2. Стандарты и новые знания
- создали стайлгайды и шаблоны, зафиксировали договоренности. должны быть простыми, понятными и короткими.
- термин, how-to, страница сервиса и инструкция - шаблоны
- новые знания - глоссарий, база знаний для 1 команды, описание архитектуры
Шаг 3. Разработчики (как привлечь?)
- писали на общую рассылку, рекламировали сделанные работы другим командам
- DoD = база знаний, команда сама вносит правки, если необходимо
- deadline driven documentation - пишем -> публикуем -> фидбек -> правки -> пишем, метод сработал, разработчики писали комментарии, говорили, где нужно обновить
- как привлечь - сарафанное радио, сначала заработать репутацию
Шаг 4. Оценка качества документации
- взяли метрики - актуальность, посещаемость, снижение затрат на техподдержку, не подошли.
- решили измерить охват - количество команд, с которыми работали.
- также измерили используемость - 80% документации живая.
Итого
- 4 базы знаний, стайлгайд и шаблоны, глоссарий, описание архитектуры, описание архитектуры
- осталось 4387 неразобранных страниц
- ушло 6 месяцев и 2 технических писателя