Colay / Руководства

Перепишите статью базы знаний, сохранив точность инструкции

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

Определите одного читателя и одну задачу

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

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

Вымышленный пример с неизменяемыми фактами

Представим вымышленный рабочий сервис. Участник может отключить личные письма в Settings → Notifications. Только владелец меняет общие настройки организации. Сохранённое изменение влияет на будущие письма, но не удаляет сообщения, уже стоящие в очереди. Это придуманные условия примера, а не возможности Colay.

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

Выбирайте структуру по затруднению читателя
Ситуация читателяПолезный форматФакт, который нужно сохранить
Я знаю, что хочу изменитьНумерованная инструкцияУказанное место настройки: Settings → Notifications
Не могу изменить общую настройкуРазбор по ролямНужное право есть только у владельца
Отключил письма, но получил ещё одноКороткое объяснение исключенияСообщения в очереди не отменяются

Промпт, который отделяет редактуру от фактов о продукте

Используйте Ask separately в Colay, чтобы увидеть, как выбранные агенты понимают задачу. Сравните планы до доработки полных текстов. Если один ответ убрал условие о правах, а другие оставили, проверьте утверждённый источник. Совпадение ответов не заменяет прохождения описанной процедуры в продукте.

Перепиши утверждённую статью базы знаний: [текст]. Карточка задачи: [аудитория, версия продукта, роль, точные названия элементов, результат, исключения]. Подготовь пошаговую инструкцию, разбор неполадок и короткий FAQ. Сохрани все условия, права и исключения. Не выдумывай элементы интерфейса или поведение продукта. Для каждой версии укажи исходное предложение, на которое опирается каждый шаг. Неясные и противоречивые фрагменты вынеси в список вопросов. Предложи одну структуру для [ситуация читателя] и объясни выбор. Не объединяй молча факты о разных версиях продукта.

Превратите лучший черновик в готовую редакцию

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

  1. Выберите структуру, которая соответствует карточке задачи. Заимствуйте удачные предложения из других вариантов только после проверки смысла.
  2. Пройдите каждый шаг в поддерживаемой версии продукта с указанной ролью. Проверьте названия, порядок, результат и описанное исключение.
  3. Прочитайте статью глазами нового пользователя: условия должны появляться до момента, когда они понадобятся, а неудачный шаг — иметь понятное продолжение.
  4. Зафиксируйте проверяющего, версию статьи и изменённые разделы. Опубликуйте материал обычным способом, сохранив прошлую редакцию для сравнения.

Оценивайте правки по действиям читателя

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

Вопросы и ответы

Нужно публиковать все восемь версий?

Обычно нет. Это кандидаты для одной задачи читателя. Публикуйте наиболее понятный подходящий вариант; отдельные статьи нужны лишь для действительно разных потребностей.

Модель может исправить устаревшую инструкцию?

Если вы передали проверенные новые факты. Правдоподобное название кнопки ещё не доказывает, что продукт работает именно так.

Что делать с частными примерами клиентов?

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

Источники и методология

  1. Google: написание процедур

    Первичное руководство о понятных действиях и контексте; вымышленная процедура и метод проверки — примеры этой статьи.

Задайте следующий вопрос в Colay

Выберите модель, используйте Auto или объедините несколько точек зрения с Consensus.

Переписать статью