Документы для IDE, must have хренотень
Работая над новыми проектами понял на сколько важна постоянно обновляемая документация для эффективной работы. У норм разрабов, кто активно прогает с ИИ, такая документация достигает 40% строк проекта.
Сначала генерировал доки с помощью разных MCP, но их всегда было много, они не поддерживались и по факту не использовались.
К чему в итоге пришел:
1. папка docs на англ для LLM с всего 3 документа:
— ARCHITECTURE.md - архитектура, структура, патерны, правила, как делаем, как не делаем, отсутствие оверинжиниринга, единые источники правды, базовые примеры. Использую при создании нового чата (новый контекст), или если в текущем контекст "забился" или если есть сомнения что корректно проектируем
— BUSINESS_LOGIC.md - для повышения доп. контекста со стороны целей
— design-system.md - все визуальные патерны
2. папка tasks на рус — прежде чем делать +- сложную задачу, проектирую в документе, проверяю сам и/или перекидываю документ между Claude/GPT5, на предмет допиливая задачи до нужного мне уровня.
3. После завершения задачи - обновляю док. задачи и архитектуры, если что поменялось. И/или проверяю реализацию на архитектурное соответствие через принудительное добавление в контекст файла архитектуры.
Дико экономит токены и главное, учитывая моё нубство в разработке - моё время на разработку/переделку, тк код не дублируется, пишется в одном, верном, заданном направлении.
Работая над новыми проектами понял на сколько важна постоянно обновляемая документация для эффективной работы. У норм разрабов, кто активно прогает с ИИ, такая документация достигает 40% строк проекта.
Сначала генерировал доки с помощью разных MCP, но их всегда было много, они не поддерживались и по факту не использовались.
К чему в итоге пришел:
1. папка docs на англ для LLM с всего 3 документа:
— ARCHITECTURE.md - архитектура, структура, патерны, правила, как делаем, как не делаем, отсутствие оверинжиниринга, единые источники правды, базовые примеры. Использую при создании нового чата (новый контекст), или если в текущем контекст "забился" или если есть сомнения что корректно проектируем
— BUSINESS_LOGIC.md - для повышения доп. контекста со стороны целей
— design-system.md - все визуальные патерны
2. папка tasks на рус — прежде чем делать +- сложную задачу, проектирую в документе, проверяю сам и/или перекидываю документ между Claude/GPT5, на предмет допиливая задачи до нужного мне уровня.
3. После завершения задачи - обновляю док. задачи и архитектуры, если что поменялось. И/или проверяю реализацию на архитектурное соответствие через принудительное добавление в контекст файла архитектуры.
Дико экономит токены и главное, учитывая моё нубство в разработке - моё время на разработку/переделку, тк код не дублируется, пишется в одном, верном, заданном направлении.