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