Перейти к содержимому

Как мы устарели более 500 статей: масштабная очистка документации — Эйлин Мэри

Write the Docs

0:00 / 0:00

Как мы устарели более 500 статей: масштабная очистка документации — Эйлин Мэри

562 просмотра · 5 мес. назад
Write the Docs
4,21 тыс. подписчиков
562 просмотра · 5 мес. назад
Докладчик: Эйлин Мэри Представьте себе небольшой SaaS-продукт с хорошо структурированным справочным центром. Документация лаконична, точна и проста в поддержке. Ответственность за контент органично переходит от менеджеров по продукту к маркетологам, а затем к команде поддержки, и какое-то время это работает. Затем команда поддержки предупреждает: «Мы могли бы улучшить показатели отвлечения внимания бота на 30%, просто исправив контент». Наши статьи с решениями подпитывали нашего бота поддержки, и бот был настолько хорош, насколько хороша была документация, на основе которой он обучался. По мере того, как наша компания развивалась от одного продукта для малого и среднего бизнеса до корпоративной платформы, документация росла взрывными темпами. С каждой итерацией мы добавляли новые статьи, не удаляя старые. Кроме того, мы накопили статьи с часто задаваемыми вопросами (FAQ), большинство из которых дублировали контент, уже существовавший в длинных статьях. Проблема заключалась не в недостатке документации, а в её избытке. В этом докладе я расскажу о следующем: Как мы устарели более 500 статей, что составляет почти 30% нашей базы знаний, благодаря систематическому процессу, основанному на данных и согласованному с показателями поддержки и приоритетами продукта. Как мы проводили аудит контента, используя сигналы, основанные на времени и трафике. Как мы согласовывали решения по устареванию контента с командами разработки продукта и поддержки. Наша система обновления, удаления или объединения контента. Измеримое влияние на точность ботов и почему качество важнее количества. Запись сделана на конференции Write the Docs Portland 2026. https://www.writethedocs.org/conf/por...