Шаблон LIMITATIONS.md

Каждая система, которую я выпускаю, идёт с файлом LIMITATIONS.md рядом с README. В нём записано, чего система не делает, что делает упрощённо и что сломалось, пока я её гонял. Софт, который перечисляет только свои сильные стороны, — это реклама.

Здесь скелет этих файлов, PDF на 8 страниц (на английском).

Что внутри

• Зачем нужен этот файл: заказчик больше доверяет README, следующий инженер начинает с правильного места, а я перестаю врать себе.
• Шаблон из четырёх разделов, готовый к копированию: By design, Operational, Found by running it, Known rough edges. Что идёт в каждый раздел и проверка одним вопросом для него.
• Как его заполнять: начинать с ограничения как с существительного, называть механизм, говорить, что нужно, чтобы это изменить, в какую сторону оно ломается, ставить даты проверок, сохранять эвристики, от которых отказались.
• Три разобранных примера, обобщённых: AI-пайплайн приёма заявок, приложение для планирования питания, RAG-бот поддержки.
• Чек-лист из одиннадцати пунктов, по которому стоит проверить файл перед запуском. Последний пункт и есть настоящая проверка.

Для кого

Для всех, кто отдаёт систему кому-то другому: клиенту, команде, ревьюеру. Ничего не предполагает о стеке. В примерах — воркфлоу, веб-приложение и бот с поиском по базе, но для скрипта файл читается так же.