Шаблоны статей базы знаний

Шаблоны статей базы знаний

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

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

Использовать этот шаблон

Использовать этот шаблон

База знаний полезна ровно настолько, насколько полезны статьи внутри нее. С Trupeer вы можете сэкономить часы на написании статей базы знаний, начиная с готовых шаблонов, адаптируя их под ваши бренд-гайдлайны и превращая текстовые материалы в понятные видеоинструкции, с которыми действительно могут взаимодействовать и клиенты, и сотрудники.

Что такое статья базы знаний и что исправляет шаблон?

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

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

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

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

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

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

В данных это выглядит как самый странный паттерн в любом help centre: статьи с высокой посещаемостью и высоким объемом тикетов по одной и той же теме. Статью находят. Ее читают. Она ни к чему не приводит.

Исправление — не в более качественном письме. Это две строки, для которых у большинства шаблонов нет поля: в первую очередь нужно сказать, что именно охватывает эта статья, и куда идти, если это не ваш случай.

Как настроить этот шаблон в Trupeer

Шаг 1: Откройте раздел Templates

Перейдите в раздел Templates из главного меню.

Open the Templates section in Trupeer

Шаг 2: Выберите и откройте шаблон

Нажмите на любой шаблон, с которым хотите работать, чтобы открыть его.

Select and open a template in Trupeer

Шаг 3: Разверните просмотр шаблона

При необходимости разверните просмотр шаблона, чтобы увидеть полную раскладку и детали.

Expand the template view in Trupeer

Шаг 4: Отредактируйте шаблон

Нажмите Edit, чтобы начать изменять выбранный шаблон.

Edit the template in Trupeer

В редакторе вы можете:

  • Добавлять новые разделы

  • Задавать или обновлять правила форматирования

  • Добавить логотип и настроить его положение и связанные параметры

Шаг 5: Сохраните настроенный шаблон

После того как вы внесете все необходимые изменения, нажмите Save, чтобы сохранить обновленный шаблон как свой.

Save your customized template in Trupeer

Шаг 6: Предпросмотр и точная настройка шаблона

Когда вы захотите увидеть, как выглядит ваш настроенный шаблон, откройте Preview.

Preview and fine-tune the template in Trupeer

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

С шаблонами статей базы знаний вы можете:

  • Экономить время на написании: Используйте проверенные структуры для гайдов, FAQ и статей по устранению неполадок.

  • Снижать количество обращений в поддержку: Понятные статьи помогают пользователям решать вопросы самостоятельно — уменьшая нагрузку на поддержку и освобождая агентов для более сложных случаев.

  • Оставаться в фирменном стиле: Применяйте логотип, шрифты и цвета из бренд-набора Trupeer — чтобы каждая статья выглядела так, будто она относится к вашему продукту.

  • Улучшать обнаруживаемость: Стандартные структуры делают статьи проще для просмотра, поиска и обновления.

  • Локализовать по всему миру: Переводите статьи базы знаний на 65+ языков в один клик.

  • Добавлять видеоинструкции: Сочетайте статьи со встроенными видео для шагов, которые сложно объяснить только текстом.

Две строки, которые нужен каждый шаблон статьи базы знаний

Строка охвата. Одно предложение, которое называет ситуацию, к которой относится эта статья, в терминах читателя, а не ваших. Не «Эта статья относится к аккаунтам тарифного плана Standard», а «Если вы входите по адресу электронной почты и паролю». Читатель должен иметь возможность сверить это с тем, что он видит.

Строка выхода. Одно предложение, которое называет самую распространенную соседнюю ситуацию и дает на нее ссылку. «Если в вашей компании используется единый вход (SSO), перейдите сюда».

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

Дисциплина важнее, чем сами строки. Записывая строку выхода, вы вынуждены назвать соседние случаи, а когда вы их называете, обычно выясняется, что у двух или трех из них вообще нет статьи.

Типы статей базы знаний и когда использовать каждый

Тип

Чего хочет читатель

Структура

Строка охвата обычно называет

Как сделать

Как мне сделать это, что я решил сделать

Пронумерованные шаги с ожидаемыми результатами

План, уровень прав или версия интерфейса

Устранение неполадок

Что-то пошло не так, и я не знаю почему

Сначала симптом, затем ветвление по тому, что читатель может увидеть

Симптом — точно, чтобы люди с другим симптомом ушли

FAQ

Короткий фактический вопрос с коротким ответом

Вопрос как заголовок, ответ в две строки, без вступления

Обычно не нужен, а если нужен — вопрос слишком общий

С чего начать

Я новичок и не знаю, что делать в первую очередь

Короткий упорядоченный путь с конечным состоянием, а не экскурсия по функциям

Роль, потому что у нового администратора и нового пользователя разные пути

Известная ошибка или служебная заметка

Это сломано у всех или только у меня

Статус, влияние, обходной путь, ожидаемое решение, время последнего обновления

Затронутые версии, регионы или планы

Справка

Я знаю, что делать, мне нужно значение

Таблица и почти ничего больше

Какая среда или аккаунт применимы к значениям

Самая распространенная структурная ошибка — писать проблему устранения неполадок как «как сделать». Если читатель еще не знает, что именно не так, пронумерованные шаги имеют неправильную форму, потому что первый шаг предполагает диагностику, которую он еще не сделал. Начните с симптома и ветвите. Наш шаблон статьи «как сделать» раскрывает первую строку подробнее.

Бесплатный шаблон статьи базы знаний: структура, которую нужно копировать

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

Заголовок, обязательно. Вопрос читателя в его формулировке. «Я не могу войти» лучше, чем «Устранение проблем с аутентификацией». Заголовки, написанные как ярлыки, а не как проблемы, — самая частая причина того, что хорошую статью никогда не находят.

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

Строка охвата, обязательно. Как выше.

Строка выхода, обязательно. Как выше.

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

Тело. Шаги, ветвления или таблица — в зависимости от типа.

Что делать, если это не сработало. Названный следующий шаг: конкретная другая статья, форма или очередь. Не «связаться с поддержкой».

Владелец и дата последней проверки. Человек и дата, когда кто-то в последний раз подтвердил, что статья все еще соответствует реальности. Не дата, когда редактировали формулировки.

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

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

FAQ. Заголовок: «Могу ли я изменить дату выставления счета?». Охват: аккаунты, которым выставляют счета ежемесячно. Ответ, в первых двух строках: да, один раз за цикл выставления, в разделе Billing, затем Schedule, и изменение вступает в силу в следующем цикле. Выход: годовые планы, перейдите сюда. Это вся статья.

Как сделать. Заголовок: «Добавьте пользователя в рабочее пространство». Охват: вы администратор. Выход: если вы не видите Settings, значит вы не администратор, обратитесь к своему. Шаги: четыре, у каждого — ожидаемый результат. Затем: что делать, если приглашение не приходит.

Устранение неполадок. Заголовок: «Экспорт завершился, но файл пустой». Охват: экспорты со страницы Reports. Первая ветка — то, что читатель может проверить без помощи, обычно это диапазон дат. Вторая ветка — права. Третья — известное ограничение. Каждая ветка заканчивается либо «решено», либо названным следующим шагом.

Известная ошибка. Заголовок: «Экспорты для аккаунтов в ЕС задерживаются». Статус, кто затронут, что делать пока, когда будет опубликовано следующее обновление, и время последнего обновления — это поле, которое читатели ищут на самом деле.

Пример статьи базы знаний: высокая посещаемость, много тикетов

Loxwell — продукт для расчета зарплат примерно для одиннадцати тысяч бизнес-клиентов — имел help centre примерно из одиннадцати сотен статей и команду контента, которой доверяли.

Статья о сбросе пароля получала около четырнадцати тысяч двухсот просмотров в квартал. Тикеты по паролям за тот же период составляли примерно девятьсот и не менялись два года. Оба показателя ежемесячно сообщали разным людям в разных наборах.

Однажды кто-то в итоге поставил их рядом. В статье был описан стандартный сброс: введите email, нажмите на ссылку, выберите новый пароль. Около шестидесяти процентов тикетов по паролям приходили от пользователей, чьи компании включили единый вход (SSO), где ссылка для сброса не дает полезного результата, потому что провайдер идентификации хранит пароль. В статье никогда не упоминался единый вход. Эти читатели находили статью, следовали ей, видели, что она не работает без сообщения об ошибке, и открывали тикет.

Исправление заняло полдня. Две строки вверху существующей статьи, где описан стандартный случай и указано, что пользователям с SSO нужно идти в другое место, плюс новая короткая статья для этих пользователей, плюс фраза, которую люди действительно вводили в поисковую строку — все это добавили в обе.

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

В тот же день обнаружилось второе число. Из одиннадцати сотен статей триста сорок вообще не получали просмотров за двенадцать месяцев. С ними тоже все было в порядке.

Как написать хорошую статью базы знаний — шаг за шагом

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

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

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

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

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

Что должен включать каждый шаблон статьи базы знаний?

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

Все остальное зависит от типа. Шаги, ветвления, таблицы, блоки со статусом и скриншоты меняются в зависимости от типа статьи, и шаблон, который требует их для каждой статьи, одинаково хорошо приводит к «раздутым» FAQ и тонким гайдам по устранению неполадок.

Как внедрить шаблоны по всей существующей базе знаний

Не переделывайте всю библиотеку. Команды, которые пытаются сделать это, обычно «застревают» примерно на статье девяносто и оставляют два заметно разных стандарта — это хуже, чем один плохой.

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

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

Как измерять эффективность статей базы знаний?

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

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

Как поддерживать статьи базы знаний без цикла переписывания

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

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

Удаление — та часть, которую команды стараются избегать. Триста сорок статей без просмотров не лежат тихо: они размывают результаты поиска и делают полезные статьи сложнее для доступа. Библиотека, которая только растет, не поддерживается. Там, где важна более широкая дисциплина, наш шаблон управления знаниями описывает владение и жизненный цикл по всей инфраструктуре.

Могу ли я получить шаблон статьи базы знаний в Word или Excel?

Word подходит для самой статьи, если ваша команда сначала готовит черновик перед публикацией, хотя писать прямо в help centre обычно быстрее, потому что вы видите отображение и поля поиска. Excel подходит для индекса статей — списка всех статей с владельцем, типом, датой последней проверки, просмотрами и объемом тикетов по теме; именно этот индекс делает измерения выше возможными.

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

Шаблоны сайта базы знаний и HTML: что эта страница не делает

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

Разницу важно прояснить, потому что эти два решения не связаны. Выбор платформы help centre или темы — это веб- и дизайн-решение про поиск, навигацию, отображение на мобильных устройствах и права доступа. Структура статьи — это решение про написание. Красивый help centre, полный статей без строк охвата, все равно будет генерировать тикеты, а простой help centre с хорошими статьями — нет.

Если вы выбираете, где будут жить статьи, а не то, что в них будет, наш шаблон базы знаний описывает структуру, категории и владение.

Как превратить запись экрана в статьи базы знаний

Узкое место в каждом help centre — это не то, что вы не знаете, что писать. Проблема в том, что человек, который знает ответ, уже решил задачу и пошел дальше, а оформление занимает час, которого у него нет.

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

Запишите. Оформите. Переведите. Trupeer it.

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

Часто задаваемые вопросы

Есть ли бесплатный шаблон статьи базы знаний в Word?

Структура из шести полей выше написана так, чтобы ее можно было вставить прямо в Word или Google Docs и использовать как основу для черновика. Нет ограниченной загрузки, а значит, нет формы между вами и структурой. Большинство команд обнаруживают, что перестают использовать версию для Word в течение месяца и вместо этого пишут в help centre — это нормально и быстрее.

Есть ли шаблон базы знаний в Excel?

Используйте Excel для индекса статей, а не для самих статей. Колонки для заголовка, типа, владельца, даты последней проверки, просмотров в этом квартале и тикетов по этой теме. Этот лист превращает help centre из набора страниц в то, чем можно управлять, и на настройку уходит около часа.

Где найти примеры шаблонов статей базы знаний?

Четыре заполненных примера находятся в разделе examples выше и охватывают FAQ, как сделать, устранение неполадок и известную ошибку. Самое полезное упражнение — взять ваши три самых просматриваемых статьи и добавить к каждой строку охвата и строку выхода, потому что ваши пограничные случаи специфичны для вашего продукта и ни один пример их не содержит.

Есть ли бесплатный шаблон FAQ в Word?

Статья FAQ требует меньше структуры, чем любой другой тип. Вопрос как заголовок, сформулированный ровно так, как его спрашивают клиенты, ответ полностью в пределах двух строк и ничего больше. Если ответ не помещается в две строки, это не FAQ — это статья «как сделать» или по устранению неполадок, которую неправильно назвали.

Есть ли шаблоны статей для Zendesk Guide?

Zendesk Guide поддерживает шаблоны статей через систему тем, и шесть полей выше сопоставляются с ней без проблем: заголовок и поисковые ключевые слова — это нативные поля, а строка охвата и строка выхода находятся в верхней части тела. Структура здесь сделана независимой от платформы специально, потому что команды мигрируют между help centre чаще, чем ожидают.

Есть ли бесплатный шаблон базы знаний в HTML?

Это другой артефакт: сайт, а не статья, и он описан в разделе выше о том, что эта страница не делает. Если вам нужен help centre с темой, большинство платформ поставляются с ним, а кастомизация — это работа фронтенда, а не письма.

Есть ли бесплатный шаблон сайта базы знаний?

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

Какой длины должна быть статья базы знаний?

Достаточно короткой, чтобы ответ был виден без прокрутки на телефоне. Для FAQ — две строки. Для «как сделать» — меньше примерно девяти шагов, а дальше обычно это уже две статьи. Длина не является целью сама по себе: цель в том, чтобы читатель мог понять в течение восьми секунд, что он находится в нужном месте.

Кто должен писать статьи базы знаний?

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

Need a video editor, translator, and a scriptwriter?

Try Trupeer for Free

Book a Demo

Need a video editor, translator, and a scriptwriter?

Try Trupeer for Free

Book a Demo

Need a video editor, translator, and a scriptwriter?

Try Trupeer for Free

Book a Demo