Knowledge Portal · engineering documentation

Skip to content

ZAIXOS Engineering Platform — Evolution Model

Document type: Technical Specification
Version: 1.0 · Phase: 12-3
Status: Permanent technical authority
Governance: PLATFORM_VERSIONING_POLICY.md


Purpose

Describe how every platform dimension evolves — components, APIs, contracts, adapters, documentation, validation — and how products consume change safely.


Evolution principles

IDRule
EV-01Additive change preferred over breaking change
EV-02Breaking change requires ADR + MAJOR + migration guide
EV-03Contract obligation change requires new contracts@N
EV-04Products pin exact versions on release branches
EV-05Adapters re-certify on contract MAJOR
EV-06Extensions evolve independently in product Git
EV-07Documentation evolves with platform semver footer
EV-08Validation may add checks in MINOR; remove only in MAJOR with deprecation

Evolution matrix

DimensionAdditive (MINOR/PATCH)Breaking (MAJOR)Product action
Platform componentsNew procedure/workflow in defaultsRemove/rename Public pathLock bump + rematerialize
Public API docsNew template section optionalRemove Public pathRead migration guide
ContractsClarification only in PATCH docNew obligations @N+1Wait for adapter cert
AdaptersPATCH template fixHook behavior breakingRematerialize
Extension schemaOptional fieldsRequired field / limit decreaseUpdate manifest
ValidationNew check (MINOR)Remove checkCI update
Configuration schemaOptional yaml fieldslockSchema MAJORRegenerate lock
KnowledgeNew packN/AOptional adopt

Component evolution

Platform core packages

ChangeVersionProcess
Doc fix in methodologyPATCHCHANGELOG
New default workflow skillMINORADR optional; validation update
Remove default workflowMAJORADR; migration guide
Reorganize internal pathsINTERNALNo product impact if Public unchanged

Runtime manifests

ChangeImpact
Add optional manifest fieldschema MINOR
Change default inventory countschema MAJOR + platform MAJOR + contracts review

API evolution

Public API changes follow PLATFORM_PUBLIC_API.md:

Proposal → RFC (optional) → ADR → Update PUBLIC_API doc
    → Implement → Validation → Release

Classification changes: Experimental → Public requires ADR + 2 release cycles minimum in Experimental.


Contract evolution

contracts@1 (frozen for platform 1.x)

Need new obligation identified

ADR + contracts@2 draft

Adapter impact analysis

Platform 2.0.0 + adapter re-cert

Migration guide for products

Rule: No silent obligation changes in PATCH/MINOR.


Adapter evolution

ScenarioAdapter versionPlatform version
Typo in SKILL.mdPATCHPATCH (bundled)
New platform-approved default skillMINORMINOR
Hook behavior changePATCH or MINORCoordinated release
Contract @2 supportMAJORMAJOR

Products: update lock.adapter.version + rematerialize.


Documentation evolution

Doc classVersioning
Governance (Constitution)Amendment ADR; rare
Product definitionProduct spec version footer
Technical architecturetechnical/ footer + index
Developer guidePlatform semver

Single source: Index points to canonical doc; superseded docs get Deprecated banner.


Validation evolution

ChangeRelease
New ExtensionSchema checkMINOR
Stricter checksum enforcementMINOR (with CHANGELOG)
Remove legacy ERP path checkMAJOR (post embedded sunset)

Products: run updated suite on MINOR bump; expect new failures = fix forward.


Product consumption of evolution

PATCH upgrade

Update lock PATCH → composer update → rematerialize if adapter changed → validation

MINOR upgrade

Review CHANGELOG additive items → update lock → composer update → rematerialize → validation → merge

MAJOR upgrade

ADR review → migration guide execution → extension updates → architect acceptance
    → lock MAJOR → composer update → rematerialize → full acceptance checklist

Additive change rules

Allowed without MAJOR
New optional platform.yml field
New extension registry entry type (with schema MINOR)
New certified adapter ID (existing products unaffected)
New validation check that passes on current pins
New knowledge pack
New template optional section

Breaking change rules

Requires MAJOR
Remove Public API path
Change default manifest inventory count
New required platform.yml field
Contract obligation add/remove/redefine
Remove certified adapter
extension schema incompatible change
lockSchema breaking change

Migration rules

RuleDetail
Guide requiredEvery platform MAJOR ships docs/migrations/
Dual-runEmbedded + vendored parity during Dental Clinic migration (12-6–12-8)
RollbackPrevious lock + composer restore valid 12 months
Support windowPrevious MAJOR PATCH for 12 months post new MAJOR GA

Compatibility matrix maintenance

Published each release:

Platformcontracts@AdapterslockSchemaextensionSchema
1.0.x1cursor-adapter-v111

Products MUST NOT assume matrix row without verifying lock.


RFC → ADR → TDR flow

TypeScope
RFCExploratory; may archive
ADRGovernance/strategy decisions
TDRTechnical shape decisions

Breaking evolution starts with ADR; technical implementation details in TDR.


Evolution Model v1.0 — Phase 12-3.

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