Как правильно составить документ CLAUDE.md для работы с агентами
Кайл Мистеле поделился важными рекомендациями по созданию документа CLAUDE.md, который является ключевым элементом работы с агентами в Claude Code, а также для аналогичных инструментов, таких как OpenCode, Zed, Cursor и Codex.
Основные рекомендации
-
Структура документа. В CLAUDE.md обязательно должны быть освещены вопросы «что», «зачем» и «как». Это включает в себя описание используемых технологий, структуры проекта и инструкции для нейронной сети о том, как ей следует работать. Необходимо объяснить цели каждого компонента проекта и предоставить карту кодовой базы.
-
Универсальность инструкций. Следует помнить, что агент может проигнорировать файл, если не считает его актуальным для текущей задачи. Поэтому в документе необходимо указать только универсальные инструкции, применимые к разным задачам.
-
Количество инструкций. Для более продвинутых моделей рекомендуется включать от 100 до 150 предположений, так как чем меньше модель, тем ниже её производительность. При этом общий объём документа не должен превышать 300 строк, что значительно упростит его восприятие.
-
Разделение на файлы. Если проект крупный, лучше разбить инструкции на отдельные Markdown-файлы для конкретных задач, с указанием их расположения в CLAUDE.md.
-
Избегайте команд для генерации. Использование команды
/initдля автоматической генерации файла нежелательно. Важно тщательно продумывать каждую инструкцию, так как некорректная строка может вызвать ошибки в коде.
Заключение
Следуя данным рекомендациям, можно существенно повысить эффективность взаимодействия с агентами, а также улучшить качество работы с кодом. Подробно ознакомиться с рекомендациями можно в оригинальной статье.
Поделиться этим постом:








