Содержание документации08 / 16

Основной процесс08 / 16

Поддерживайте объяснения в актуальном состоянии

На этой странице

После изменения требований или кода проверьте, остаются ли объяснения применимыми. Используйте Объяснить (Explain) на боковой панели для объяснений, требующих внимания во всём проекте, или действие Исследование (Investigation) у абзаца для проверки одного фрагмента.

Определите, что изменилось

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

«Может устареть» не обязательно означает ошибочный вывод: изменение файла может не относиться к делу. «Изменения не найдены» не доказывает, что тесты проходят или все функции готовы.

Исследуйте один абзац

Сохраните документ, наведите указатель на абзац и выберите Исследование (Investigation) слева. Существующее примечание на полях также может предлагать Исследовать снова (Investigate Again).

Это обновляет объяснение только выбранного фрагмента. Если в нём есть несохранённые изменения, исследование недоступно, и Noea предложит сначала сохранить документ.

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

Обновите объяснения во всём проекте

Нажмите Объяснить (Explain) на боковой панели, чтобы проверить содержимое, ожидающее исследования, и объяснения, чьи подтверждающие файлы изменились. Действие недоступно, если проект не открыт, доступен только для чтения или не имеет привязанной папки реализации.

Запущенная вручную задача Explain открывает чат с этапами, ходом работы и отдельными результатами. Пока она выполняется, обычные сообщения в этот чат отправлять нельзя, но можно пользоваться другими чатами проекта.

По завершении разверните результаты: посмотрите, какие объяснения изменились, какие остались верными, какие проверки завершились с ошибкой или не были закончены. Завершение задачи не означает успеха всех проверок.

Поймите, что проверил Explain

Explain сравнивает требования с кодом и проверяет объяснения как уровня абзаца, так и локального уровня. Верные объяснения он сохраняет, а нуждающиеся в исправлении обновляет; переписывать каждое объяснение необязательно.

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

Узнайте, когда Explain запускается автоматически

Настройка Settings → Current Project → Automation → Explain automatically after implementing включена по умолчанию. Основные условия запуска:

ДействиеАвтоматический Explain
Принять предложение, меняющее требования и ещё требующее реализации.После штатного завершения задачи реализации.
Принять предложение, меняющее требования, которым реализация уже соответствует.После принятия.
Начать работу через Realize на боковой панели.После штатного завершения первого ответа.
Принять план организации, меняющий текст требований.После принятия, независимо от указанной выше настройки.
Упорядочить только имена файлов или структуру папок.Не запускается.
Изменить только код в обычном чате, выбрать Implement Directly либо остановить реализацию или получить ошибку.Не запускается; запустите Explain вручную.

Автоматический Explain работает в фоне без создания обычного чата. Продолжайте исходный чат и смотрите ход работы в разделе Runs.

Просматривайте записи и повторяйте запуск

В разделе Runs на боковой панели сохраняются задачи объяснения. Разверните задачу, чтобы посмотреть доступные только для чтения записи её запусков. Они остаются доступными после переключения чатов или перезапуска приложения.

После ошибки или прерывания выберите Запустить снова (Run Again). Существующие объяснения сохранятся. Когда новый запуск закончится, проверьте, обработал ли он ранее неудачные или незавершённые элементы.

Выберите агента для каждой операции

Агент для Explain зависит от того, как запускается задача. Настройки операций проекта и область их действия описаны в статье Агенты, модели и использование.

Если объяснения не обновляются, см. статью Устранение неполадок и частые вопросы.