Шаблон LIMITATIONS.md

Кожна система, яку я запускаю, йде з файлом LIMITATIONS.md поруч із README. У ньому написано, чого система не робить, що вона робить спрощено і що зламалось, поки я її експлуатував. Софт, який перелічує тільки свої сильні сторони, — це реклама.

Тут скелет, на якому стоять ці файли, у вигляді PDF на 8 сторінок (англійською).

Що всередині

• Навіщо цей файл: покупець більше довіряє README, наступний інженер починає з правильного місця, а я перестаю обманювати себе.
• Шаблон, чотири розділи, готові до копіювання: By design, Operational, Found by running it, Known rough edges. Що йде в кожен і тест з одного питання для нього.
• Як його заповнювати: починати з обмеження як іменникової фрази, називати механізм, казати, що знадобиться, щоб це змінити, казати, в який бік воно ламається, ставити дати перевірок, зберігати евристики, від яких ви відмовились.
• Три розібрані приклади, узагальнені: AI-пайплайн прийому заявок, застосунок для планування харчування, RAG-бот підтримки.
• Чекліст з одинадцяти пунктів, який варто пройти по файлу перед запуском. Останній пункт і є справжня перевірка.

Для кого

Для всіх, хто передає систему комусь іншому: клієнту, команді, рецензенту. Шаблон нічого не передбачає щодо стеку. У прикладах воркфлоу, вебзастосунок і бот з пошуком по документах, але для скрипта файл читається так само.