Knowledge Portal · engineering documentation

Skip to content

ZAIXOS Engineering Platform — Adoption Model

Document type: Product Definition
Version: 1.0 · Phase: 12-2
Status: Permanent product authority


Adoption Lifecycle

New Product

Platform Installation

Customization (extensions)

Development (phases + AI runtime)

Validation (local + CI)

Upgrade (platform pin bump)

Release (product version)

Platform Upgrade (scheduled)
    ↺ (cycle)

Each stage has explicit Platform, Product, Architect, and Developer responsibilities.


Stage 1 — New Product

RoleResponsibilities
PlatformPublish supported platform version matrix; provide bootstrap documentation
ProductCreate product repo; adopt product constitution; choose Laravel baseline
ArchitectDefine product module boundaries; plan phase roadmap
Developer— (not yet engaged)

Exit criteria: Product repo exists with architecture docs; decision to adopt ZEP recorded.


Stage 2 — Platform Installation

RoleResponsibilities
PlatformDeliver package/submodule; document install steps; provide default manifests
ProductAdd dependency; create .zaixos/platform.lock; wire Composer
ArchitectApprove platform version pin; approve adapter choice (Cursor v1 default)
DeveloperExecute install; run first validation

Exit criteria: .zaixos/ present; lock file committed; integrity tests executable.


Stage 3 — Customization

RoleResponsibilities
PlatformMaintain extension schema; document allowed customization
ProductRegister .zaixos/extensions/manifest.yml entries; never patch vendor core
ArchitectReview extensions for architecture alignment
DeveloperImplement extension content; rematerialize adapter if required

Exit criteria: Extensions registered; no undocumented .cursor/ drift.


Stage 4 — Development

RoleResponsibilities
PlatformProvide phase templates, RESPONSE_TEMPLATE, runtime spec
ProductImplement domain features in app/Modules/
ArchitectIssue phase prompts; review Format A/B reports; issue RESPONSE_TEMPLATE decisions
DeveloperExecute Runtime Implementation; produce ERP/platform reports; use adapter workspace

Exit criteria: Phase accepted by architect; no boundary violations.


Stage 5 — Validation

RoleResponsibilities
PlatformMaintain integrity tests; document pass criteria
ProductConfigure CI to run architecture + platform tests on PR
ArchitectBlock merge on validation failure for architectural phases
DeveloperFix failures; run locally before push

Exit criteria: Green CI including platform suite.


Stage 6 — Upgrade (Product Release Cycle)

RoleResponsibilities
PlatformPublish release notes
ProductSchedule pin bump; execute product release
ArchitectAccept release phase; confirm no scope creep
DeveloperImplement features; tag product release

Note: Product release does not require platform upgrade every time.


Stage 7 — Release

RoleResponsibilities
Platform— (unless platform defect discovered)
ProductTag product version; deploy application
ArchitectFreeze acceptance per product freeze policy
DeveloperExecute Git freeze procedure (product); not platform freeze

Stage 8 — Platform Upgrade

RoleResponsibilities
PlatformSemver release; migration guide; deprecation notices
ProductBump lock + composer; integration branch; CI green
ArchitectApprove major upgrades; assess ADR impacts
DeveloperApply migration steps; rematerialize adapter

Cadence: Patch/minor — quarterly review; major — ADR + architect approval.


Responsibility Summary Matrix

ActivityPlatformProduct (org)ArchitectDeveloper
Platform core sourceR/ACII
Product domain codeIR/AAR
Platform pin versionPAAR
Extension manifestP (schema)R/AAR
Phase acceptanceP (process)IR/AR
CI validation wiringP (tests)R/AAR
Adapter certificationR/ACII
Git freeze (product)IAAR
Platform release tagR/ACII

R/A = Responsible/Accountable · C = Consulted · I = Informed


Adoption Patterns

Pattern A — Greenfield Product

Install platform at latest stable v1.x → empty modules → phases from day one.

Pattern B — Migration (Dental Clinic)

Embedded ERP → platform package → remove duplicate docs → lock file → KPI-10 to zero.

Pattern C — Experimental Spike

Defer platform until productization ADR; spike repos not long-lived without migration plan.


Failure Modes & Escalation

SymptomLikely ownerAction
Validation fails on fresh installPlatformFix package or docs
Module boundary failProduct / ArchitectFix product code
Adapter missing contract fileAdapter maintainerPatch adapter release
Architect/ERP doc conflictPlatform docsFix platform index
Developer edited vendor platformProductRevert; use extensions

Adoption Prerequisites Checklist

Before adopting ZEP, product must confirm:

  • [ ] PHP/Laravel product (v1) or future adapter path accepted
  • [ ] Architect role assigned
  • [ ] CI can run PHPUnit architecture tests
  • [ ] Team accepts phase + RESPONSE_TEMPLATE discipline
  • [ ] No requirement from Never Included scope (PRODUCT_SCOPE.md)

Adoption Model v1.0 — Phase 12-2.

ZAIXOS Knowledge Portal — public engineering docs at /docs · Staff operations at /admin