Статьи Knowledge - это поддерживаемые документы для политик, пояснений и другой некаталожной информации. Текущий редактор поддерживает заголовок, краткое описание, основной форматированный текст, заголовки, списки, ссылки, изображения, видео, таблицы, разделители, кнопки, выравнивание и другое форматирование.

В этом руководстве рассматривается жизненный цикл контента: от владения источником до состояний Public или Private и Published или Draft. Также объясняется, почему перед появлением измененной статьи в новом неизменяемом публичном снимке требуется повторная публикация Helpdesk.

Как это вписывается в Humind

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

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

Перед началом

Доступ: Для создания, редактирования, публикации, снятия с публикации, перемещения или удаления статьи требуется доступ на запись в Knowledge. Для публикации Helpdesk требуется соответствующий административный доступ Helpdesk.

• Определите авторитетного владельца политики или темы.
• Поищите в существующих источниках Knowledge, чтобы предотвратить дублирование авторитетного источника.
• До начала написания выберите папку, аудиторию, дату проверки и целевую локаль Helpdesk.

Пошаговый рабочий процесс

1. Создайте статью в правильной папке

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

   Если тема не относится к публичной документации, еще раз оцените, не будет ли лучшим источником частная статья, сниппет, веб-страница или документ.

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

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

   При документировании продукта используйте точные текущие ярлыки Humind. Не включайте частные id, внутренние конечные точки, учетные данные, предположительные функции или скриншоты, которые сразу устареют.

3. Задайте видимость и жизненный цикл

   Откройте панель настроек Knowledge и выберите Public или Private, затем Published или Draft. Public управляет аудиторией, Published управляет тем, активен ли элемент. Публичный черновик не готов для рабочего Helpdesk.

   Подтвердите любую настройку активного периода или допустимости для Helpdesk, используемую компанией. Оставляйте элемент в черновике, пока проверяющие еще устраняют фактические или юридические вопросы.

4. Проверьте и протестируйте источник

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

   Исправляйте статью или конфликтующий источник, а не тестовый запрос. Начинайте новый разговор после изменений состояния публикации или контента.

5. При необходимости опубликуйте новую версию Helpdesk

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

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

Разрешения и важные оговорки

• Public и Published - это независимые настройки, и обе влияют на доступность для клиентов.
• Удаление статьи - это разрушительное действие, поэтому сначала снимите ее с публикации, если важны проверка или история.
• Богатое форматирование должно поддерживать понимание и доступность, а не служить украшением.
• Публикация Helpdesk сохраняет снимок содержимого статьи, поэтому более поздние изменения в Knowledge требуют еще одной публикации.

Проверьте результат

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

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

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

Статья сохранена, но не является публичной

Проверьте Public или Private, Published или Draft, активный период, допустимость для Helpdesk, выбор проекции и локаль. Опубликуйте новую версию Helpdesk после того, как все условия будут правильными.

Agent игнорирует статью

Убедитесь, что она сохранена и активна в текущей компании, удалите конфликтующие источники Knowledge, используйте новый разговор в Playground и задайте вопрос, который действительно соответствует области статьи.

Внутренняя ссылка не работает

Используйте стабильный маршрут статьи Helpdesk и существующий опубликованный slug для той же локали. Не ссылайтесь на черновик, частный элемент, URL редактора или id базы данных.

Связанные руководства

• Настройка надежной базы Knowledge
• Упорядочьте Knowledge с помощью папок
• Используйте сниппеты для повторно используемых инструкций
• Проверьте своего Agent в Playground