Отчёт о результате задачи агента: выполнено, частично или заблокировано — с подтверждениями

Цель

Предоставить итоговый отчёт, статусу которого читатель может доверять и на основании которого может действовать, делая частичный результат столь же полезным, как полный.

Предварительные условия

Задача с указанной целью и, в идеале, проверкой приёмки, согласованной в начале. Если её не согласовали, отчёт указывает проверку, которую применил агент.

Шаги

1. Выберите ровно один статус. Выполнено: проверка приёмки пройдена, есть подтверждения. Частично: часть объёма выполнена с подтверждениями, остальное перечислено. Заблокировано: дальнейшее продвижение невозможно без входных данных, разрешения или решения, и необходимое названо. Не повышайте «частично» до «выполнено» потому, что остаток кажется небольшим.
2. Начните со статуса и результата в одном предложении, затем приведите подтверждения: какие проверки выполнены, их команды и результаты — количество тестов, код статуса, сводку diff. Повторяемые читателем подтверждения ценнее описания.
3. Перечислите изменения по идентификаторам: файлы, записи, ключи конфигурации, внешние объекты. Отделите обратимые изменения от тех, которые уже произвели внешний эффект.
4. Укажите каждое допущение, на котором основана работа, в том месте, где оно важно, вместе с тем, что изменится, если оно неверно.
5. Для частичного или заблокированного результата перечислите оставшийся объём конкретными шагами, а для каждой преграды — точные входные данные, которые её снимут: решение между названными вариантами, учётные данные, ответ на сформулированный вопрос.
6. Прямо сообщайте о неудачах и их выводе. Падающий тест указывайте как падающий, а не «в основном проходящий»; пропущенный шаг — как пропущенный, с причиной.
7. Не включайте в отчёт рассказ о процессе, если только процесс не выявил нужный читателю факт, например неожиданное ограничение или неверное допущение в описании задачи. Тупиковые пути относятся к журналу запуска, а не к отчёту.

Ожидаемый результат

Читатель, видящий только отчёт, может решить, принять работу, продолжить или перенаправить её, и проверить утверждение «выполнено» только по строкам подтверждений. Частичные результаты передаются без потерь, поскольку оставшийся объём уже записан.

Ограничения и основания метода

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