Решённое обращение, применимые условия, аудитория, актуальные сведения о продукте и связанные статьи.
Статья с известным решением, предварительными условиями, разбором затруднений и правилами пересмотра.
Кому пригодится
Сотрудникам поддержки и редакторам базы знаний.
Требования и ограничения
Превратить решённое обращение в статью базы знаний
Knowledge Base Article Writer помогает использовать опыт поддержки повторно: из решённого обращения готовит статью, которую другие пользователи смогут найти самостоятельно. Материал объясняет распространённую проблему и действия, которые уже помогли её устранить.
Входной материал — обращение с известным решением. Для создания пользовательской инструкции с нуля предусмотрен другой скилл. Здесь особенно важен переход от ответа одному клиенту к объяснению, подходящему для повторяющегося случая.
Как выбрать тему
Автор предлагает брать темы, с которыми обращались разные клиенты, либо проблемы, которые руководитель поддержки считает повторяющимися. Разовые исключения и устаревшие функции обычно дают мало пользы для общей справки.
Перед подготовкой стоит указать аудиторию статьи: клиенты или сотрудники поддержки. В опубликованном пользовательском тексте внутренние термины заменяют понятными словами, а детали конкретного обращения обобщают до применимых условий.
Как строится статья
- Заголовок повторяет вопрос или задачу в словах клиента.
- Краткое вступление объясняет, кому подходит решение и что покрывает статья.
- Предварительные условия перечисляют необходимые права, настройки или материалы.
- Основная часть содержит шаги либо короткое объяснение причины.
- Отдельный раздел разбирает частые случаи, когда решение не помогает.
- Связанные статьи дают переход к соседним задачам.
Как сделать ответ заметным
Решение наиболее частого случая ставят в начало. Название и первые предложения используют выражения, с которыми человек ищет помощь. Скилл предлагает учитывать близкие формулировки запроса, если они относятся к описываемому действию.
Ответ сотрудника поддержки не переносят дословно: в нём могут отсутствовать условия, уже известные конкретному клиенту. Каждый шаг должен содержать одно действие. Снимки экрана помогают там, где нужно найти настройку или распознать состояние интерфейса.
Какие сведения требуют отдельной проверки
Решение должно соответствовать текущему продукту. Сроки, ограничения и объяснение причины берут из подтверждённых материалов команды. Например, приведённый в исходнике пример с двумя списаниями не доказывает причину конкретного платежа и не задаёт срок возврата для любого сервиса.
Ссылки на связанные материалы подбирают из существующей базы знаний. Если нужной статьи пока нет, полезнее отметить пробел при подготовке, чем публиковать выдуманный адрес.
Как поддерживать статью после выпуска
Исходник предлагает назначать пересмотр через 90 дней и отмечать материал при изменении продукта или правил. Также в нём есть рекомендация архивировать статьи без посещений за 180 дней. Это политика автора, которую владельцу базы знаний стоит соотнести с собственной статистикой и редкими, но важными обращениями.
Результат работы — готовый текст с условиями, решением, разбором затруднений, связанными ссылками и датой пересмотра. Публикация и дальнейшее отслеживание посещений требуют отдельного процесса.
Автор и источник
Оригинальное название: kb-article-writer
Автор или репозиторий: SkillMedev/skills
Лицензия: MIT
Открыть первоисточник