74 lines
4.6 KiB
Markdown
74 lines
4.6 KiB
Markdown
# Шаблон проекта
|
|
|
|
Универсальный шаблон для старта любых проектов. Содержит правила, архитектуру, чеклисты, шаблоны кода и документацию, собранные на основе реального опыта.
|
|
|
|
## Быстрый старт
|
|
|
|
1. Скопировать `template/` в корень нового проекта
|
|
2. Прочитать `PRINCIPLES.md` — понять философию
|
|
3. Дать `AI_CONTEXT.md` ИИ-ассистенту — он поймёт как работать с проектом
|
|
4. Настроить `templates/.env.example` → `.env`
|
|
5. Начать писать код согласно `docs/03-project-structure.md`
|
|
|
|
## Карта шаблона
|
|
|
|
```
|
|
template/
|
|
├── README.md # Этот файл
|
|
├── AI_CONTEXT.md # Полная инструкция для ИИ-ассистента
|
|
├── PRINCIPLES.md # Философия и принципы работы
|
|
├── project.yaml # Машиночитаемое описание проекта
|
|
│
|
|
├── docs/
|
|
│ ├── 00-rules.md # Конституция проекта (главные правила)
|
|
│ ├── 01-architecture.md # Слоистая архитектура
|
|
│ ├── 02-stack.md # Технологический стек
|
|
│ ├── 03-project-structure.md # Структура папок и файлов
|
|
│ ├── 04-versioning.md # Версионирование (SemVer + agent versioning)
|
|
│ ├── 05-testing.md # Стандарты тестирования
|
|
│ ├── 06-security.md # Безопасность
|
|
│ ├── 07-performance.md # Производительность и метрики
|
|
│ ├── 08-error-handling.md # Обработка ошибок
|
|
│ ├── 09-logging.md # Логирование
|
|
│ ├── 10-documentation.md # Стандарты документации
|
|
│ ├── 11-dependencies.md # Управление зависимостями
|
|
│ ├── 12-code-review.md # Процесс ревью кода
|
|
│ ├── 13-git-flow.md # Git ветки и коммиты
|
|
│ ├── 14-data-retention.md # Политика хранения данных
|
|
│ ├── 15-migration-policy.md # Политика миграций БД
|
|
│ ├── 16-api-lifecycle.md # Жизненный цикл API
|
|
│ ├── 17-self-development.md # Саморазвитие и эволюция
|
|
│ ├── migration-path.md # Поэтапный план взросления проекта
|
|
│ ├── env-management.md # Управление переменными окружения
|
|
│ ├── api-testing-strategy.md # Стратегия тестирования API
|
|
│ └── decision-log.md # Лёгкий трекер решений
|
|
│ ├── agents/
|
|
│ │ ├── 00-agents-overview.md
|
|
│ │ ├── 01-agent-architecture.md
|
|
│ │ ├── 02-agent-versioning.md
|
|
│ │ └── templates/
|
|
│ ├── adr/
|
|
│ │ └── 000-template.md
|
|
│ ├── agent-prompts/
|
|
│ │ ├── README.md
|
|
│ │ ├── patterns.md
|
|
│ │ ├── storage.md
|
|
│ │ └── templates/
|
|
│ ├── decisions/ # Руководства по выбору технологий
|
|
│ ├── checklists/ # Чеклисты (pre-commit, review, deploy, etc.)
|
|
│ └── runbook/ # Эксплуатация (startup, backup, incident)
|
|
│
|
|
├── templates/ # Готовые шаблоны файлов
|
|
├── .github/ # GitHub интеграция (CI/CD, issue templates)
|
|
├── notes/ # Заметки (проблемы, улучшения)
|
|
└── examples/ # Примеры кода
|
|
```
|
|
|
|
## Ключевые принципы
|
|
|
|
- **Правила важнее кода** — код можно переписать, культуру нет
|
|
- **Агенты с первого коммита** — 4 ядерных агента живут с рождения проекта
|
|
- **Документация как код** — если это не записано, этого не существует
|
|
- **Спрашивай если сомневаешься** — все неоднозначные решения помечены `[ASK]`
|
|
- **Саморазвитие** — проект должен становиться умнее без участия человека
|