Создание видеобазы знаний с помощью записи экрана

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

Видеобаза знаний сочетает глубину визуальных объяснений с доступностью справочных материалов по запросу. Вот как создать её так, чтобы ваша команда действительно использовала её.

Почему видео превосходит текст для процедурных знаний

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

Ключевые преимущества видеобазы знаний:

• Сокращает повторяющиеся вопросы: Запишите однажды, делитесь бесконечно
• Фиксирует неявные знания: Документирует «как», которое эксперты делают автоматически
• Ускоряет адаптацию: Новые сотрудники могут решать вопросы самостоятельно, не ожидая помощи
• Последовательное обучение: Каждый получает одинаковое объяснение каждый раз
• Простое обновление: Перезапишите при изменении процессов, форматирование не требуется

Планирование структуры базы знаний

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

Организация по ролям или командам

Структурируйте контент вокруг тех, кто в нём нуждается:

• Адаптация: Основное для новых сотрудников на первую неделю
• Инженерия: Настройка среды разработки, процедуры развёртывания, руководства по отладке
• Дизайн: Руководство по бренду, инструкции по инструментам, процессы проверки
• Поддержка: Распространённые проблемы клиентов, сценарии устранения неполадок, процессы эскалации
• Операции: Процессы с поставщиками, финансовые рабочие процессы, процедуры соответствия

Использование последовательного соглашения об именах

Принять шаблон именования до начала и придерживаться его:

[Команда] - [Тема] - [Подтема]
engineering - github - creating-pull-requests
support - zendesk - handling-refund-requests
design - figma - exporting-assets-for-dev

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

Советы по записи контента для базы знаний

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

Делать видео краткими и сфокусированными

Стремитесь к записям менее пяти минут. Если тема требует больше времени, разделите её на серию:

• Часть 1: Настройка среды
• Часть 2: Запуск первой сборки
• Часть 3: Устранение распространённых ошибок

Короткие видео легче найти, обновить и перезаписать при изменении процессов.

Записывать в комфортном темпе

Говорите чётко и перемещайте курсор целенаправленно. Зрители, незнакомые с инструментом, нуждаются во времени, чтобы следить за вашими действиями. Темп, кажущийся вам чуть медленным, часто оказывается именно тем, что нужно учащемуся.

Использовать эффекты масштабирования для ключевых деталей

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

Добавлять краткое вступление и заключение

Начинайте каждую запись с одного предложения, объясняющего, что рассматривается и для кого. Заканчивайте чётким заявлением о завершении. Это позволяет зрителям убедиться, что они смотрят правильное видео, прежде чем инвестировать время.

Создание библиотеки с возможностью поиска

Запись видео — только половина работы. Обнаруживаемость определяет, будет ли использоваться ваша база знаний.

Писать описательные заголовки и описания

Каждое видео должно иметь:

• Заголовок: Конкретный и ориентированный на действие («Как развернуть в staging», а не «Развёртывание»)
• Описание: Краткое изложение из 2-3 предложений о том, что показано и кому это нужно
• Теги: Ключевые слова, которые кто-то будет искать для поиска этой информации

Создать центральный индекс

Ведите простой индексный документ — общую таблицу, страницу Notion или запись в вики — со ссылками на каждое видео, организованными по категориям. Обновляйте его каждый раз при добавлении нового контента.

Встраивать видео в существующую документацию

Не создавайте отдельное хранилище видео. Встраивайте записи непосредственно в текстовую документацию, процессные вики и чек-листы адаптации, которые люди уже просматривают. Запись экрана, встроенная в соответствующий runbook, просматривается; запись в автономной видеобиблиотеке — зачастую нет.

Поддержание базы знаний в актуальном состоянии

Устаревшая документация хуже, чем отсутствие документации. Формируйте привычку к обслуживанию с самого начала.

Помечать видео датой проверки

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

Делать перезапись простой

Одно из главных преимуществ записей экрана перед письменной документацией — насколько легко их обновлять. Когда процесс меняется, откройте Recorded, запишите новый обучающий материал и замените старый файл. Никакого форматирования, никакой реструктуризации — только новая запись.

Назначать ответственных

За каждым разделом базы знаний должен быть назначенный владелец, ответственный за поддержание точности. Без ответственности устаревший контент накапливается, а доверие к библиотеке подрывается.

Получение поддержки команды

База знаний работает только тогда, когда люди вносят в неё вклад. Снижайте барьер для записи.

• Нормализуйте несовершенные записи: Немного несовершенная запись, опубликованная сразу, ценнее идеальной, которую никогда не сделают
• Отмечайте вклады: Признавайте, когда кто-то добавляет полезное видео в библиотеку
• Начинайте с ценных пробелов: Определите вопросы, которые задаёт команда чаще всего, и сначала записывайте ответы на них
• Интегрируйте запись в рабочие процессы: Когда кто-то дважды отвечает на один и тот же вопрос в Slack, поощряйте его записать краткое руководство

Начало работы

Лучшее время для создания видеобазы знаний — когда команда ещё небольшая, а процессы просты. К тому времени, когда она потребуется срочно — при быстром найме, крупной миграции инструментов или реорганизации команды — вы будете рады, что начали раньше.

Выберите три вопроса, которые чаще всего задают новые участники команды, запишите для каждого короткое руководство и поделитесь ссылками. Это и есть ваша база знаний. Всё остальное — просто добавление к ней.