Knowledge Portal · engineering documentation

Skip to content

ZAIXOS Engineering Platform — Asset Lifecycle

Document type: Technical Specification
Version: 1.0 · Phase: 12-3
Status: Permanent technical authority
Related: PLATFORM_STATE_MACHINE.md · EVOLUTION_MODEL.md


Purpose

Define lifecycle, versioning, approval, deprecation, removal, migration, and compatibility for every platform asset class.

States reference PLATFORM_STATE_MACHINE.md.


Lifecycle matrix (summary)

AssetOwnerVersion IDApprovalDeprecationRemovalMigration
Platform releaseD-PsemverArchitect + validationADR + MAJOR cycleNever removed — archived tagsMigration guide per MAJOR
ContractD-Pcontracts@NADRNew @N+1Old frozen read-onlyAdapter re-cert
WorkflowD-P / D-R extmanifest + platform semverArchitectPlatform MINOR noticeMAJOR inventory changeRematerialize
ProcedureD-P / D-R extmanifest + platform semverArchitectSameSameRematerialize
RuleD-P / D-R extmanifest + platform semverArchitectSameExtension limitRematerialize
TemplateD-Pplatform semverArchitectDeprecated catalogMAJORCopy new template
KnowledgeD-P / D-Rpack id + GitArchitect (product)Doc noticeDelete packManual merge
AdapterD-Aadapter semverCertification checklistAdapter deprecationUncertifySwitch adapter ID
ManifestD-PschemaVersionADR if count changeschema MAJORN/Aschema migration
ADRD-PsequentialArchitectSuperseded by new ADRArchivedPointer update
RFCD-Pdraft idN/A until ADRAbandonArchive→ ADR
Validation suiteD-Pplatform semverPlatform DeveloperTest deprecationMAJORUpdate CI
ConfigurationD-RlockSchemaIntegratorschema MAJORN/ARegenerate lock
DocumentationD-P / D-Rdoc version footerReview state machineDeprecated catalogArchiveLink update

Platform release

PhaseActivity
CreateBranch from previous tag
Versionsemver per VERSIONING_POLICY
ApproveValidation green + CHANGELOG
PublishTag zaixos-platform@vX.Y.Z
DeprecateAnnounce in MINOR; remove features in MAJOR
Migratedocs/migrations/vN-to-vN+1.md
CompatibilityMatrix in release doc

Contract

PhaseActivity
CreateADR + contract document
Versioncontracts@N integer
ApproveArchitect + adapter impact review
PublishBundled in platform MAJOR
DeprecateNever amend @N — publish @N+1
MigrateProducts pin until adapter certified for @N+1
CompatibilityPlatform MAJOR aligns with contract MAJOR on breaks

Frozen: contracts@1 for platform 1.x — no obligation changes.


Workflow / Procedure / Delegate

PhaseActivity
CreatePlatform default in adapter template OR product extension
VersionTied to platform semver; extension via Git history
ApproveArchitect phase acceptance
PublishMaterialization
DeprecateRemove from manifest + rematerialize
MigrateID change = new artifact; collision forbidden
CompatibilityAdditive platform MINOR adds defaults

Rule (Constraint)

PhaseActivity
CreatePlatform A–G in adapter; product C–G extensions
VersionPlatform semver
ApproveArchitect; extension rules need scope review
PublishMaterialization
DeprecateRemove file + registry entry
MigrateRecategorize forbidden for A–B product rules
CompatibilityExtensions cannot weaken A–B

Template

PhaseActivity
CreatePlatform templates/
VersionPlatform semver; section count locked per MAJOR
ApproveArchitect (RESPONSE_TEMPLATE changes = MAJOR review)
PublishPlatform release
DeprecateDeprecated catalog (e.g. eight-section template)
MigrateProducts copy new skeleton
CompatibilityFormat A/B section counts Public

Knowledge

PhaseActivity
Createknowledge/ or extensions/knowledge/
VersionInformal Git; optional pack version file
ApproveArchitect for product packs
PublishRegistration in manifest (product)
DeprecateRemove manifest entry
MigrateManual
CompatibilityNever auto-injected as constraints

Adapter

PhaseActivity
CreatePlatform adapters/{id}/
Versionadapter semver + platformCompatibility range
ApproveAdapterWorkspaceTest + manual checklist
PublishCertified adapter ID in Public API
DeprecateADR; warn in validation
RemoveMAJOR platform — uncertify ID
MigrateChange adapter.id in platform.yml + rematerialize
CompatibilityPATCH adapter with platform PATCH/MINOR

Manifest (schema + defaults)

PhaseActivity
Createruntime/manifests/
VersionschemaVersion per type
ApproveADR if inventory count changes
PublishPlatform release
Deprecateschema MAJOR
MigrateMigration guide + validation update
CompatibilityCount locked per platform MAJOR

ADR / RFC

PhaseActivity
RFCDraft → Reviewed → ADR or Archived
ADRAccepted → Released; superseded → Deprecated → Archived
VersionImmutable text; supersession pointer
MigrationNew ADR references old

Validation suite

PhaseActivity
Createvalidation/tests/
VersionPlatform semver
ApproveGreen on reference product
PublishWith platform release
DeprecateTest marked skipped one MINOR
RemoveMAJOR
MigrateProducts update CI expectations

Configuration (product)

PhaseActivity
Createplatform.yml + lock + extensions
VersionlockSchemaVersion
ApproveIntegrator + validation
PublishGit commit
Deprecateschema bump
MigrateRegenerate from schema migration tool (future CLI)
Compatibilitylock must match installed platform

Documentation

PhaseActivity
CreateAuthor draft
VersionFooter version + phase
ApproveState machine to Released
PublishIndex update
DeprecateSuperseded banner + pointer
ArchiveMove to archive/ with redirect

Removal policy (global)

Asset typeHard removal allowed
Platform tagNever — immutable history
Contract @NNever — read-only forever
Public API pathMAJOR only after deprecation
ExtensionProduct anytime (manifest)
Embedded ERP copyPhase 12-7+ product cleanup

Asset Lifecycle v1.0 — Phase 12-3.

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