Knowledge Portal · engineering documentation

Skip to content

Platform Documentation Template

Status: Template · Copy to PLATFORMS/PL-xxx-name.md


markdown
# PL-XXX — Platform Name

**Status:** Draft | Review | Canonical
**Owner:** Platform team
**Repository:** `org/repo-name`
**Version:** x.y.z
**Last updated:** YYYY-MM-DD

---

## Purpose

One paragraph: why this platform exists.

## Responsibilities

What this platform OWNS (execution, contracts, registries).

What this platform does NOT own (cite other PL-xxx).

## Architecture

```mermaid
flowchart LR
    A[Consumer] --> B[Platform Contract]
    B --> C[Internal Services]

Link: technical architecture

Contracts

ContractPurpose
*PlatformContractPrimary surface

Full index: REFERENCE/contracts-index.md

DTOs

Primary DTO families and where defined (packages/contracts).

Services

ServiceLayerNotes

Registries

| Registry | Owner |

Integration points

Products and platforms that consume this platform.

Examples

Minimal consumer integration example (cite-only code path).

Known limitations

Honest gaps — no marketing language.

Version history

VersionDateNotes

Home → Platforms → PL-XXX

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