Skip to content

Lifecycle documentation

This directory holds locked behavioral specifications for workflows, API contracts, caching, and permissions. Implementation in apps/ must follow these docs unless an ADR explicitly supersedes them.

Contents

AreaPathPurpose
Maintenancemaintenance/README.mdEnd-to-end maintenance request lifecycle, roles, data model intent
Status transitionsmaintenance/status-transitions.mdAllowed status and departmentApprovalStatus transitions
Permissionsmaintenance/permissions-matrix.mdWho may perform which actions; permissions object semantics
Snapshotsmaintenance/snapshot-behavior.mdfinalSnapshot shape, immutability, UI rules
Cache — usercache/user.mdUser profile resolution for relatedUsers
Cache — maintenancecache/maintenance.mdMaintenance list/detail invalidation and read paths
Cache — systemcache/system.mdSystem settings / feature flags cache (when applicable)
Cache — sessioncache/session.mdSession and auth-adjacent cache expectations

Change process

  1. Update the relevant file under docs/lifecycle/.
  2. If behavior changes are significant, add or update an ADR under docs/architecture/decisions/.
  3. Keep maintainer/phases/maintenance-handoff.md in sync for developer handoff (shorter operational summary).