TorbatYar/docs/workspace-roadmap.md
Mortezakoohjani a483b47369 feat(workspace): complete production workspace and content operations
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-09-12 11:54:17 +03:30

323 lines
14 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Workspace Platform Roadmap (Torbat Workspace)
> First production slice (`workspace-15.0`–`workspace-15.8`) is implemented. Next authorized phase is **`workspace-15.9`** only.
> Completed work → [progress.md](progress.md). Immediate milestone → [next-steps.md](next-steps.md). Module inventory → [module-registry.md](module-registry.md#workspace).
Independent **Workspace Platform** (commercial product: **Torbat Workspace**): enterprise work management — projects, tasks, content operations, editorial calendar, creative workflow, collaboration, files/assets, CRM/Accounting integration, AI assistant hooks, and reporting.
Category: **Platform Product**. Purpose: **Enterprise Work Management Platform**.
The Workspace Platform becomes the operational center for organizations. It includes (product intent — phased):
- Project Management · Task Management
- Content Operations · Editorial Calendar · Creative Studio
- Marketing Operations
- Team Collaboration · Client Collaboration
- File Management · Digital Assets · Approval Workflow
- OKR · KPI
- Resource Planning · Time Tracking · Project Cost Control
- Accounting Integration · CRM Integration
- AI Assistant · Reporting
Implementation of every phase must follow the [Enterprise / AI Development Framework](ai-framework/README.md) ([ADR-013](architecture/adr/ADR-013.md), [ADR-018](architecture/adr/ADR-018.md), [ADR-019](architecture/adr/ADR-019.md), [ADR-024](architecture/adr/ADR-024.md)).
---
## Phase Overview
| Phase | Identifier | Title | Status |
| --- | --- | --- | --- |
| Reg | `workspace-reg` | Workspace Platform Registration | **Complete** (docs only) |
| 15.0 | `workspace-15.0` | Workspace Foundation | **Complete** |
| 15.1 | `workspace-15.1` | Workspace Core | **Complete** (Work Hub/teams; OKR/KPI engines not built) |
| 15.2 | `workspace-15.2` | Projects | **Complete** (CRUD/progress; Gantt/resource-planning not built) |
| 15.3 | `workspace-15.3` | Tasks | **Complete** |
| 15.4 | `workspace-15.4` | Content Studio | **Complete** |
| 15.5 | `workspace-15.5` | Creative Workflow | **Complete** |
| 15.6 | `workspace-15.6` | Collaboration | **Complete** (comments/mentions/activity; notes entity not built) |
| 15.7 | `workspace-15.7` | Calendar | **Complete** |
| 15.8 | `workspace-15.8` | Files & Assets | **Complete** (asset references only) |
| 15.9 | `workspace-15.9` | CRM & Accounting Integration | Planned |
| 15.10 | `workspace-15.10` | AI & Analytics | Planned |
| 15.11 | `workspace-15.11` | Enterprise Validation | Planned |
Phase documents are created at implementation time from [phase-template.md](ai-framework/phase-template.md). This roadmap is the registration SoT until then.
---
## Naming (normative)
| Term | Owner | Do not confuse with |
| --- | --- | --- |
| **Torbat Workspace** | this product | Core Tenant Workspace |
| **Work Hub** | this service | Experience Workspace; Payment Workspace |
| **Workspace Project** | this service | Accounting analytical **Project** |
| **Workspace Task** | this service | CRM sales **Task** |
| Events `workspace.*` | this service | `experience.workspace.*`, `payment.workspace.*` |
See [ADR-024](architecture/adr/ADR-024.md) and [glossary.md](glossary.md).
---
## Phase 15.0 — Workspace Foundation
**Objective:** Independent `workspace` / `workspace-service` scaffold with tenant-aware foundation aggregates, permissions, publish-only events, provider contracts, health/capabilities — no project/task/content engines.
**In scope (planned):**
- Service folder `backend/services/workspace` (future implementation); deployable name `workspace-service`
- Database `workspace_db`; API prefix `/api/v1`; port **8013** (reserved)
- Foundation shells: WorkHub, WorkspaceRole, WorkspacePermission, ExternalProviderConfig, WorkspaceConfiguration, WorkspaceSetting, WorkspaceAuditLog, OutboxEvent
- Provider contracts only: Identity, CRM, Accounting, File Storage, Communication, Experience, AI Assistant
- Permissions `workspace.*`; events `workspace.*`
- Health `/health`, capabilities `/capabilities`, metrics `/metrics`
- Alembic `0001_initial` (at implementation); architecture / tenant / permission / migration / docs tests
**Out of scope:** Projects, tasks, kanban/gantt engines, content studio, creative review, collaboration threads, calendars, DAM, CRM/Accounting adapters, AI, analytics, frontend.
**Capabilities unlocked:** none beyond module enablement (`workspace.module.enabled` planned).
---
## Phase 15.1 — Workspace Core
**Objective:** Product kernel — Work Hub, spaces/teams, settings, OKR/KPI shells, capability discovery.
**In scope (planned):** Work Hub lifecycle, spaces/teams, core settings, permission catalog expansion, OKR/KPI definition shells, capability flags for later modules.
**Out of scope:** Project/task engines, content production, file binaries, CRM/Accounting postings, AI execution.
**Capabilities:** `okr`, `kpi` (shells).
---
## Phase 15.2 — Projects
**Objective:** Project management aggregates — project lifecycle, membership, resource-planning shells, project cost-control shells, Gantt-ready structure (no full scheduler UI).
**In scope (planned):** Workspace Project, project members, status/lifecycle, resource-planning shells, project cost-control shells (intents only), Gantt structure refs.
**Out of scope:** Accounting journals, CRM opportunities, task board engine (15.3), calendar engine (15.7).
**Capabilities:** `projects`, `gantt`, `resource-planning`.
---
## Phase 15.3 — Tasks
**Objective:** Task management and Kanban — work items, assignment, status, board views.
**In scope (planned):** Workspace Task, lists/boards, Kanban columns, assignment, due dates, task events, `workspace.tasks.*` permissions.
**Out of scope:** CRM sales tasks, time-tracking engine (may attach later), creative approvals (15.5), calendar recurrence (15.7).
**Capabilities:** `tasks`, `kanban`.
---
## Phase 15.4 — Content Studio
**Objective:** Content operations — editorial items, marketing content pipeline, content status — not Experience pages.
**In scope (planned):** Content items, content types, editorial status, content operations events.
**Out of scope:** Experience sites/pages/themes ([ADR-016](architecture/adr/ADR-016.md)), publish_id issuance ([ADR-022](architecture/adr/ADR-022.md)), creative review engine (15.5).
**Capabilities:** `content`.
---
## Phase 15.5 — Creative Workflow
**Objective:** Creative studio workflow — review cycles, approval workflow, creative-review states.
**In scope (planned):** Creative review packages, approval steps, decision records, `workspace.approvals.*` / `workspace.creative-review.*`.
**Out of scope:** Experience publish workflow, Identity auth challenges, Payment capture on approvals.
**Capabilities:** `creative-review`, `approvals`.
---
## Phase 15.6 — Collaboration
**Objective:** Team and client collaboration — notes, comments, mentions — work-management domain only.
**In scope (planned):** Notes, comment threads, mentions, team collaboration, client collaboration shells (guest/client refs, not Identity admin).
**Out of scope:** CRM sales timeline/comments/mentions, Communication message delivery, Live Chat / Smart Messenger ownership.
**Capabilities:** `notes`, `comments`, `mentions`.
---
## Phase 15.7 — Calendar
**Objective:** Operational and editorial calendars — scheduling views over projects, tasks, and content.
**In scope (planned):** Calendar, editorial calendar, date bindings to projects/tasks/content, calendar events.
**Out of scope:** Sports/Healthcare/Beauty booking engines, Experience appointment pages, Communication reminder delivery.
**Capabilities:** `calendar`, `editorial-calendar`.
---
## Phase 15.8 — Files & Assets
**Objective:** File management and digital asset catalog — metadata and refs only.
**In scope (planned):** Folders, file metadata, digital asset catalog, `file_ref` pointers to File Storage, asset events.
**Out of scope:** Blob storage, S3 credentials, signed-URL engine (File Storage), Experience media as page-builder SoT.
**Capabilities:** `files`, `assets`.
---
## Phase 15.9 — CRM & Accounting Integration
**Objective:** Integration contracts — CRM refs, time tracking, project cost intents to Accounting. No foreign ownership.
**In scope (planned):** CRM contact/organization/opportunity refs, time-tracking entries, project cost-control intents, Accounting posting-intent client, events for downstream consumers.
**Out of scope:** CRM Lead/Opportunity ownership, Accounting JournalEntry / Posting Engine, Payment capture, Loyalty ledgers.
**Capabilities:** `time-tracking` (plus CRM/Accounting integration contracts).
---
## Phase 15.10 — AI & Analytics
**Objective:** Optional AI assistant hooks and workspace analytics/reporting.
**In scope (planned):** Analytics snapshots, reporting shells, AI assistant capability via AI Assistant contracts, `workspace.analytics.*` / `workspace.ai-assistant.*`.
**Out of scope:** Owning `ai_assistant` product, mandatory AI for any workflow, central BI warehouse.
**Capabilities:** `ai-assistant`, `analytics`.
---
## Phase 15.11 — Enterprise Validation
**Objective:** Final enterprise-grade validation across the Workspace Platform prior to GA.
**In scope (planned):** Cross-phase quality gates, boundary audit, permission/event completeness, commercial compatibility re-check, documentation repair.
**Out of scope:** New product engines, other services' remaining phases, Commercial Runtime seed/implementation.
---
## Registered Capabilities (architecture)
Declared for Commercial Runtime / Capability Registry compatibility. **No capability rows, bundles, or engines are implemented.**
| Capability key | Label | Phase |
| --- | --- | --- |
| `workspace.projects` | projects | 15.2 |
| `workspace.tasks` | tasks | 15.3 |
| `workspace.kanban` | kanban | 15.3 |
| `workspace.calendar` | calendar | 15.7 |
| `workspace.gantt` | gantt | 15.2 |
| `workspace.content` | content | 15.4 |
| `workspace.editorial-calendar` | editorial-calendar | 15.7 |
| `workspace.creative-review` | creative-review | 15.5 |
| `workspace.approvals` | approvals | 15.5 |
| `workspace.assets` | assets | 15.8 |
| `workspace.time-tracking` | time-tracking | 15.9 |
| `workspace.resource-planning` | resource-planning | 15.2 |
| `workspace.okr` | okr | 15.1 |
| `workspace.kpi` | kpi | 15.1 |
| `workspace.notes` | notes | 15.6 |
| `workspace.comments` | comments | 15.6 |
| `workspace.mentions` | mentions | 15.6 |
| `workspace.files` | files | 15.8 |
| `workspace.ai-assistant` | ai-assistant | 15.10 |
| `workspace.analytics` | analytics | 15.10 |
---
## Commercial Product (architecture only)
| Field | Value |
| --- | --- |
| Product | **Torbat Workspace** |
| Category | Platform Product |
| Purpose | Enterprise Work Management Platform |
| Commercial Runtime | Compatible (registry entry later; no seed now) |
| Bundle | Compatible (optional Business Bundle mapping later) |
| Capability | Compatible (keys above) |
| Subscription | Compatible ([ADR-023](architecture/adr/ADR-023.md) contracts) |
| License | Compatible (L1 `workspace.module.enabled` planned) |
| Trial | Compatible (trial policy target later) |
| Implementation | **None** — no catalog YAML, no runtime rows, no admin UI, no billing |
Adding this product later to Commercial Runtime requires only PlatformProduct registration + capability rows + optional bundle mapping ([ADR-023](architecture/adr/ADR-023.md) future-product rules). Core commercial architecture does not change.
---
## Technical Registration (planned)
| Field | Value |
| --- | --- |
| Service identifier | `workspace` |
| Deployable name | `workspace-service` |
| Service folder | `backend/services/workspace` (at 15.0) |
| Database | `workspace_db` |
| API port | **8013** (reserved) |
| API prefix | `/api/v1` |
| Health | `/health` |
| Capabilities discovery | `/capabilities` |
| Metrics | `/metrics` |
| Permission prefix | `workspace.*` |
| Event namespace | `workspace.*` |
| Frontend route prefix | `/workspace` (dedicated shell; future) |
| Tenant aware | Yes (required) |
| Public contracts | Health/capabilities/metrics + versioned `/api/v1` resources (per phase) |
| Internal contracts | Token-gated CRM / Accounting / File Storage / AI / Communication refs |
| Required dependencies | Core Platform, Identity & Access, shared-lib |
| Optional dependencies | CRM, Accounting, File Storage, Communication, Experience, AI Assistant |
| Future extensions | Template marketplace, external PM connectors, mobile, portfolio/program mgmt, Automation consumer hooks |
---
## Cross-Module Dependencies
| Platform | Relationship |
| --- | --- |
| Core | Entitlement, tenant resolution, memberships; **not** work-management ownership |
| Identity | User/profile refs for members, clients, assignees |
| CRM | Optional contact / organization / opportunity refs (15.9) |
| Accounting | Time/cost posting intents only (15.9); Project cost is not a journal |
| File Storage | Binary refs for files/assets (15.8) |
| Communication | Mentions / approval / calendar notifications (client) |
| Experience | Optional public showcase pages; Content Studio does not own sites |
| AI Assistant | Optional assistant (15.10); Workspace remains usable when AI is off |
| Payment | Out of scope unless a future paid-approval action binds `publish_id` |
---
## Boundary Reminders
- Workspace owns work-management aggregates in `workspace_db` only.
- No cross-database foreign keys; no importing other services' models.
- Financial postings only through Accounting Posting Engine ([ADR-010](architecture/adr/ADR-010.md)).
- Messaging only through Communication ([ADR-012](architecture/adr/ADR-012.md)).
- Public surfaces use `publish_id` when published ([ADR-022](architecture/adr/ADR-022.md)).
- Do not implement 15.0–15.11 from this registration.
---
## Related Documents
- [ADR-024](architecture/adr/ADR-024.md)
- [Module Registry — workspace](module-registry.md#workspace)
- [Module Boundaries — Workspace](architecture/module-boundaries.md)
- [Progress](progress.md)
- [Roadmap](roadmap.md)
- [Next Steps](next-steps.md)
- [Phase Manifest](ai-framework/phase-manifest.yaml)
- [Service Manifest](ai-framework/service-manifest.yaml)
- [AI / Enterprise Development Framework](ai-framework/README.md)