docs: добавить стайлгайд nextjs-style-guide в репозиторий
- Добавлена документация SLM-архитектуры, базовых правил и прикладных разделов - Добавлены разделы: стили, SVG-спрайты, шаблоны генерации, PostCSS, REST, Realtime - Удалены устаревшие файлы (спрайты, скрипты, стили из app/)
This commit is contained in:
103
ai/nextjs-style-guide/DEVELOP.md
Normal file
103
ai/nextjs-style-guide/DEVELOP.md
Normal file
@@ -0,0 +1,103 @@
|
||||
---
|
||||
title: Гид для агента
|
||||
description: Что AI-агент обязан прочитать перед началом работы, а что — по задаче.
|
||||
---
|
||||
|
||||
# Обязательное чтение перед началом работы
|
||||
|
||||
Этот документ определяет **строгий порядок действий агента перед выполнением любых задач**.
|
||||
|
||||
## Общее правило
|
||||
|
||||
Перед началом работы над **любой задачей** агент **обязан ознакомиться с базовой документацией проекта**.
|
||||
|
||||
Нарушение этого порядка считается ошибкой.
|
||||
|
||||
---
|
||||
|
||||
## Порядок обязательного чтения
|
||||
|
||||
Агент должен читать документацию **строго в следующем порядке**:
|
||||
|
||||
### 1. Архитектура (КРИТИЧЕСКИ ВАЖНО)
|
||||
|
||||
* [Архитектура: Обзор](./basics/architecture/index.md)
|
||||
* [Архитектура: Слои](./basics/architecture/reference/layers.md)
|
||||
* [Архитектура: Модули](./basics/architecture/reference/modules.md)
|
||||
* [Архитектура: Сегменты](./basics/architecture/reference/segments.md)
|
||||
|
||||
**Архитектура — это самое важное в проекте.**
|
||||
|
||||
Агент обязан:
|
||||
|
||||
* строго понимать архитектурный подход (SLM)
|
||||
* соблюдать архитектуру **на 100% без отклонений**
|
||||
* не предлагать решений, нарушающих архитектурные принципы
|
||||
* не упрощать архитектуру даже ради скорости выполнения задачи
|
||||
|
||||
Любое нарушение архитектуры недопустимо.
|
||||
|
||||
---
|
||||
|
||||
### 2. Базовые правила
|
||||
|
||||
После архитектуры необходимо изучить:
|
||||
|
||||
* [Технологии и библиотеки](./basics/tech-stack.md)
|
||||
* [Именование](./basics/naming.md)
|
||||
* [Стиль кода](./basics/code-style.md)
|
||||
* [Документирование](./basics/documentation.md)
|
||||
* [Типизация](./basics/typing.md)
|
||||
|
||||
Агент обязан применять эти правила во всех решениях.
|
||||
|
||||
---
|
||||
|
||||
## Использование карты документации
|
||||
|
||||
Для поиска дополнительных сведений агент должен использовать:
|
||||
|
||||
* [MAP.md](./MAP.md)
|
||||
|
||||
MAP.md содержит ссылки на все прикладные и вспомогательные разделы.
|
||||
|
||||
Агент может:
|
||||
|
||||
* переходить к нужным разделам через MAP.md
|
||||
* уточнять детали реализации
|
||||
* искать примеры и частные случаи
|
||||
|
||||
---
|
||||
|
||||
## Запрещено
|
||||
|
||||
Агенту запрещено:
|
||||
|
||||
* начинать выполнение задачи без изучения архитектуры
|
||||
* игнорировать базовые правила
|
||||
* принимать решения, противоречащие архитектуре
|
||||
* придумывать собственные подходы, если они не описаны в документации
|
||||
|
||||
---
|
||||
|
||||
## Ожидаемое поведение агента
|
||||
|
||||
Перед выполнением задачи агент должен:
|
||||
|
||||
1. Изучить архитектуру
|
||||
2. Изучить базовые правила
|
||||
3. При необходимости открыть MAP.md и найти релевантные разделы
|
||||
4. Только после этого приступать к решению задачи
|
||||
|
||||
---
|
||||
|
||||
## Приоритеты
|
||||
|
||||
При принятии решений агент должен руководствоваться следующим приоритетом:
|
||||
|
||||
1. **Архитектура**
|
||||
2. Базовые правила
|
||||
3. Документация из MAP.md
|
||||
4. Задача пользователя
|
||||
|
||||
Если задача противоречит архитектуре — задача должна быть переосмыслена, а не выполнена напрямую.
|
||||
Reference in New Issue
Block a user