Ситуация
Задача длится несколько сессий. В первой удалось найти причину ошибки и изменить файл; во второй исполнитель снова начинает поиск. Хуже, если при передаче исчезает запрет менять соседний модуль. Объём истории сам по себе не гарантирует, что следующий шаг использует нужные условия.
Контрольная запись должна позволять продолжить конкретную работу. Полная хронология действий для этого обычно избыточна.
Шаблон записи
Цель: какой результат должен получить пользователь.
Приёмка: как независимо проверить этот результат.
Ограничения: что сохранять; какие действия разрешены.
Готово: результат, путь к артефакту, выполненная проверка.
Открыто: что ещё не решено и что пока неизвестно.
Следующий шаг: одно действие и ожидаемое доказательство.
Источники: файлы или записи, которые нужно перечитать.
Пример
Синтетическая задача: исправить поиск в каталоге, сохранив сортировку.
Цель: запрос «сканер» находит запись с этим названием.
Приёмка: поиск и очистка запроса; порядок записей не меняется.
Ограничения: фильтры и сортировку не заменять.
Готово: причина найдена — индекс использует только описание.
Открыто: изменение ещё не внесено и не проверено.
Следующий шаг: добавить название в индекс и проверить два запроса.
Источники: catalog-index и существующая проверка сортировки.
Это пример структуры, а не отчёт о реальном исправлении Skufosaur.
Проверка передачи
Передайте запись человеку или новой сессии, которой недоступна предыдущая переписка. Попросите назвать цель, обязательное ограничение, готовый результат и следующий шаг. Сравните ответы с исходной задачей. Если исполнителю приходится угадывать, запись не прошла проверку.
Особенно проверяйте различие между «файл изменён» и «поведение подтверждено». Незавершённая проверка должна остаться незавершённой после передачи.
Когда обновлять
Обновляйте запись после изменения цели, важного решения, проверки результата или обнаружения блокера. Не дописывайте каждый просмотр файла. Устаревшее предположение заменяйте текущим фактом, сохраняя ссылку на основание.
В публичной версии используйте искусственные имена и данные. Пароли, сообщения пользователей и содержимое закрытых журналов в такой шаблон не входят.
Источники и происхождение
- Редакция Skufosaur
Предлагаемый шаблон для синтетических задач. Не измеренный эксперимент и не настройка приложения.