Документация проекта «TASKFLOW CRM»
Данная папка содержит всю техническую и проектную документацию.
Она организована так, чтобы упростить навигацию, поддержку актуальности и совместную работу.
Навигация по документации
Для начала чтения
| Документ | Для кого | Что внутри |
|---|
| Возможности системы | Все | Обзор функций: проекты, канбан-доски, задачи, тайм-трекинг, RBAC, SSO, обратная связь |
| Руководство пользователя | Пользователи | Как работать с системой: вход, проекты, доски, задачи, время, оценки |
| Инструкция для фронтендеров | Frontend-разработчики | Аутентификация, форматы ответов, ошибки, пагинация, контракты API |
| Инструкция для разработчиков | Backend-разработчики | Локальный запуск, окружение, миграции, тесты, стиль кода, как добавить модуль |
| Недоработки и план развития | Все | Известные проблемы, некритичные баги, планируемые улучшения |
Структура папки docs/
docs/
├── README.md ← вы здесь (навигация)
├── capabilities.md # Возможности системы
├── frontend-guide.md # Инструкция для фронтендеров
├── developer-guide.md # Инструкция для разработчиков
├── user-guide.md # Руководство пользователя
├── known-issues-and-roadmap.md # Недоработки, баги, план развития
│
├── core/ # Документация ядра (core/)
│ ├── README.md
│ ├── architecture.md # Слои, DDD, Clean Architecture, CQRS
│ ├── dto.md # DTO ядра: поля, типы, примеры JSON
│ ├── commands-queries.md # Команды/запросы/хендлеры ядра
│ ├── events.md # Шина событий, доменные события ядра
│ ├── notifications.md # NotificationHub, каналы уведомлений
│ ├── exceptions.md # Иерархия исключений, формат ошибок
│ ├── security.md # YiiIdentity, scopes
│ ├── value-objects.md # Value Objects ядра
│ ├── repositories.md # Порты репозиториев и реализации
│ └── configuration.md # Конфигурация ядра, что где задаётся
│
├── modules/ # Документация модулей
│ ├── passport/ # Модуль auth (SSO через Passport)
│ ├── rbac/ # Модуль RBAC (роли и разрешения)
│ ├── projects/ # Модуль проектов
│ ├── tasks/ # Модуль задач
│ └── feedback/ # Модуль обратной связи
│
├── .diagrams/ # PlantUML-диаграммы
│ └── *.puml
├── .images/ # Сгенерированные изображения диаграмм
│
├── script-yii-template/ # Описание используемого шаблона Yii2
│ # (документация шаблона, не проекта)
└── specification/ # Спецификации проекта
├── README.md
├── code-style.md
├── external-auth-port.md
└── resources.md
Модули системы
| Модуль | Назначение | Документация |
|---|
core | Ядро: пользователи, роли, уведомления, события, ошибки, безопасность | docs/core/ |
passport/auth | Аутентификация через внешний сервис Passport (SSO), OAuth2-токены | docs/modules/passport/ |
rbac | Роли, разрешения (permissions), авторизация по маршрутам | docs/modules/rbac/ |
projects | Проекты, канбан-доски, участники, приглашения | docs/modules/projects/ |
tasks | Задачи, колонки, комментарии, стикеры, тайм-трекинг | docs/modules/tasks/ |
feedback | Оценка сервиса и идеи по улучшению | docs/modules/feedback/ |
Связанные ресурсы