docs: add docs/features scaffold for feature documentation
Introduce docs/features/ with an index (conventions + feature registry), a per-feature template, and a filled cart example. Reference the structure from the root CLAUDE.md so context can be restored per feature on demand. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
38
docs/features/_TEMPLATE.md
Normal file
38
docs/features/_TEMPLATE.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# <Название фичи>
|
||||
|
||||
> Скопируй этот файл в `docs/features/<feature-slug>/CLAUDE.md` и заполни секции.
|
||||
> Удали подсказки в кавычках после заполнения. Не оставляй пустых «TODO».
|
||||
|
||||
## Назначение
|
||||
|
||||
> 1–3 предложения: какую задачу решает фича и для кого (SPA-покупатель / админ / системное).
|
||||
|
||||
## Точки входа
|
||||
|
||||
> `action` из карт маршрутов и где они объявлены. Таблица:
|
||||
|
||||
| action | Метод | Где объявлен |
|
||||
|-----------------|-------------------|-------------------------------------------|
|
||||
| `exampleAction` | `Handler::method` | `src/routes.php` или `bastion/routes.php` |
|
||||
|
||||
## Ключевые файлы по слоям
|
||||
|
||||
> Путь от корня репозитория. Только то, что реально относится к фиче.
|
||||
|
||||
- **Handler:** `module/.../src/Handlers/XxxHandler.php` — валидация, вызов сервиса, `JsonResponse`.
|
||||
- **Service:** `module/.../src/Services/XxxService.php` — бизнес-логика.
|
||||
- **Model / данные:** `module/.../src/Models/Xxx.php` или таблицы БД.
|
||||
- **Фронтенд:** `frontend/spa/...` или `frontend/admin/...` (store, view, компоненты).
|
||||
- **Регистрация в DI:** `src/ServiceProviders/...` (если есть нестандартная привязка).
|
||||
|
||||
## Поток данных
|
||||
|
||||
> Кратко: запрос → слои → ответ. Можно списком шагов или стрелками.
|
||||
|
||||
## Связанные фичи
|
||||
|
||||
> Ссылки на соседние папки: `[checkout](../checkout/CLAUDE.md)`.
|
||||
|
||||
## Нюансы и подводные камни
|
||||
|
||||
> Неочевидное: ограничения PHP 7.4, особенности OpenCart-реестра, кэш, edge-cases, известные баги.
|
||||
Reference in New Issue
Block a user