Files
ProxyWarden/.agent/checklists/explanation-quality.md

1.4 KiB
Raw Permalink Blame History

Checklist: Explanation Quality

Используй перед финальным ответом или PR summary.

Обязательное

  • В начале есть короткий итог на 24 пункта.
  • Есть список файлов или таблица файл / что / зачем.
  • Термины объяснены простыми словами, если они важны.
  • Нет длинных полотен без заголовков.
  • Нет пересказа каждой строки diff.
  • Указано, что проверено.
  • Указано, что не проверено.
  • Риски написаны прямо, без «должно работать».

Хороший формат

## Коротко
- ...

## Файлы
| Файл | Что | Зачем |
|---|---|---|

## Проверки
- Выполнено: ...
- Не выполнено: ...

## Риски
- ...

Плохие признаки

  • Один огромный абзац.
  • Много терминов без пользы.
  • «Исправлена логика» без указания файла и эффекта.
  • «Проверено» без команды или способа проверки.
  • «Не проверял Windows, но всё готово».
  • Список из 25 пунктов одинаковой важности.