architect/templates/arh/PROJECT_IT.md

Шаблон: PROJECT_IT

Версия: 1.0.0
Наследует: PROJECT_BASE
Тип: business (IT)


Описание

Шаблон для IT-проектов — веб-приложения, API, сервисы, интеграции.

Примеры: pirotehnika/, lider/, @ozon.api/, @pim.service/


Структура проекта

{project}/
├── CLAUDE.md               AI-контекст
├── index.yaml              Метаданные

├── design/                 Проектирование
   ├── BRIEF.md            Понимание задачи
   ├── REQUIREMENTS.md     Требования
   ├── DESIGN.md           Архитектура системы
   ├── DATA_MODEL.md       Модель данных (специфика IT)
   └── API.md              API спецификация (специфика IT)

├── management/             Управление
   ├── STATUS.md           Текущий статус
   ├── TODO.md             Задачи
   ├── CHANGELOG.md        История изменений
   └── RELEASES.md         Релизы (специфика IT)

├── solution/               Код (специфика IT)
   ├── src/                Исходный код
   ├── tests/              Тесты
   └── migrations/         Миграции БД

├── testing/                Тестирование
   ├── TEST_PLAN.md        План тестирования
   └── DEFECTS.md          Найденные баги

├── operations/             Эксплуатация
   ├── DEPLOY.md           Инструкция деплоя
   ├── ROLLBACK.md         План отката
   ├── MONITORING.md       Мониторинг
   └── RUNBOOK.md          Операционные процедуры

├── _shared/                Общие данные (если есть)
   └── ...

└── @modules/               Подмодули (опционально)
    ├── @api.service/
    ├── @web.app/
    └── ...

Отличия от PROJECT_BASE

Элемент PROJECT_BASE PROJECT_IT
design/DATA_MODEL.md Нет Да — модель данных
design/API.md Нет Да — API спецификация
solution/src/ Нет Да — исходный код
solution/tests/ Нет Да — тесты
testing/ Опционально Обязательно
operations/ Опционально Обязательно
management/RELEASES.md Нет Да — история релизов

Шаблон: CLAUDE.md для IT-проекта

# {Название проекта}

**Тип:** business
**Статус:** {draft | development | production}
**Обновлено:** {YYYY-MM-DD}

---

## Что это

{1-2 предложения: что делает, для кого, какую проблему решает}

---

## Технологии

| Компонент | Технология |
|-----------|------------|
| Backend | {Python/Node/PHP/...} |
| Frontend | {React/Vue/...} |
| База данных | {PostgreSQL/MySQL/...} |
| Деплой | {Docker/K8s/...} |

---

## Модули

| Модуль | Тип | Описание |
|--------|-----|----------|
| `@name.api/` | API | {Описание} |
| `@name.app/` | Web | {Описание} |

---

## Текущий фокус

{Что сейчас в работе}

**Статус:** [management/STATUS.md](management/STATUS.md)
**Задачи:** [management/TODO.md](management/TODO.md)

---

## Запуск

```bash
# Development
{команда запуска dev}

# Production
{команда запуска prod}

Серверы

Среда Сервер URL
Production @{server}.server {url}
Staging

Ключевые файлы

Файл Назначение
solution/src/main.py Точка входа
design/API.md API документация

Версия: {X.Y.Z}

---

## Шаблон: DATA_MODEL.md

```markdown
# DATA_MODEL — {Проект}

**Обновлено:** {YYYY-MM-DD}

---

## Сущности

### {Entity1}

| Поле | Тип | Описание |
|------|-----|----------|
| id | UUID | Идентификатор |
| name | string | Название |
| created_at | timestamp | Дата создания |

### {Entity2}

...

---

## Связи

Entity1 --< Entity2 (1:N)
Entity2 >-- Entity3 (N:1)

---

## Индексы

| Таблица | Поля | Тип |
|---------|------|-----|
| entity1 | name | btree |

---

## Миграции

См. `solution/migrations/`

Шаблон: API.md

# API — {Проект}

**Версия:** v1
**Base URL:** `{base_url}/api/v1`

---

## Аутентификация

{Тип: Bearer Token / API Key / ...}

Authorization: Bearer {token}

---

## Endpoints

### {Resource}

#### GET /{resource}

Получить список.

**Параметры:**
| Параметр | Тип | Описание |
|----------|-----|----------|
| limit | int | Лимит (default: 20) |
| offset | int | Смещение |

**Ответ:**
```json
{
  "items": [...],
  "total": 100
}

GET /{resource}/{id}

Получить по ID.

POST /{resource}

Создать.

Body:

{
  "name": "string"
}

PUT /{resource}/{id}

Обновить.

DELETE /{resource}/{id}

Удалить.


Коды ошибок

Код Описание
400 Bad Request
401 Unauthorized
404 Not Found
500 Internal Error
---

## Шаблон: RELEASES.md

```markdown
# RELEASES — {Проект}

---

## v1.2.0 (YYYY-MM-DD)

### Added
- Новая функция X

### Changed
- Изменено поведение Y

### Fixed
- Исправлен баг Z

### Deprecated
- Метод A устарел

---

## v1.1.0 (YYYY-MM-DD)

...

---

## v1.0.0 (YYYY-MM-DD)

Первый релиз.

Когда использовать


Версия: 1.0.0