База знаний для AEO: как написать понятную инструкцию
В инструкции нужно объяснить не только действия, но и условия, при которых они доступны. Если функция есть лишь на одном тарифе или требует прав администратора, читатель должен узнать об этом до начала настройки. Иначе он будет искать кнопку, которой у него нет.
Такую проверку стоит сделать основой работы над базой знаний для AEO. Полезный ответ позволяет человеку выполнить задачу, проверить результат и понять, куда обратиться при ошибке. Само появление ссылки в ответе ИИ не говорит, что инструкция с этим справляется.
Сначала укажите, кому подходит инструкция
Перед первым шагом назовите версию или вариант продукта, необходимые права и предварительные настройки. Все условия, без которых выполнить действия нельзя, должны быть видны сразу.
Например, в инструкции GitLab по двухфакторной аутентификации есть предварительные условия, порядок действий и ссылки на восстановление доступа. Здесь мы рассматриваем устройство документации, а не её результаты в поиске с ИИ.
Опишите действия, результат и возможные ошибки
В таблице — учебный план инструкции по выгрузке заказов. Конкретные права, форматы и названия меню нужно проверить в своём продукте: пример не описывает готовый интерфейс.
| Часть | Что подтвердить перед публикацией |
|---|---|
| Задача | Какие заказы пользователь хочет получить |
| Условия | Кому доступна функция и за какой период можно выгрузить заказы |
| Действия | Какие пункты меню открыть и что выбрать |
| Результат | Где появляется файл и какие данные в нём есть |
| Ошибка | Что делать, если файл не появился или в нём нет нужных записей |
| Следующий шаг | К кому обратиться, если инструкция не помогла |
Пройдите все шаги с тестовой учётной записью. Проверьте также, что увидит человек без нужных прав. Текст должен объяснять причину ограничения и дальнейшие действия. В публичные примеры не включайте данные клиентов, ключи доступа и внутренние процедуры.
Разделяйте материалы по задачам читателя
Инструкцию по настройке экспорта и описание полей файла можно разместить отдельно, если они нужны для разных задач. Добавьте между ними ссылки, чтобы читателю не пришлось искать продолжение. Саму пошаговую инструкцию лучше не разбивать на множество страниц только ради коротких ответов.
В материалах о старых версиях укажите, к каким версиям они относятся. Перед удалением устаревшей инструкции выясните, остались ли пользователи прежней системы. Им может быть нужен старый порядок действий, даже если для новых клиентов он уже не подходит.
Определите, кто будет обновлять документацию
Назначьте сотрудника, который проверяет инструкции при изменении продукта. Когда меняются меню, ограничения или результат операции, нужно пересмотреть соответствующие статьи и переводы. Обновляйте дату после такой проверки, а не просто для того, чтобы страница выглядела свежей.
Добавление разметки и файлов для роботов не заменит проверку инструкций. В частности, Google не требует специального файла для функций ИИ. Подробнее о возможностях и ограничениях такого файла — в гайде о llms.txt.
Большую базу знаний удобнее дорабатывать постепенно: выберите часто используемую инструкцию и проверьте связанные с ней страницы. При заказе работ по AEO можно согласовать редактуру, структуру раздела и технические изменения. Подтверждение фактов о продукте остаётся за вашей командой.
Опубликовано: · Проверено редакцией geo-rank.ai · Как мы проверяем