Documentation Metadata Schema

Every page should include YAML front matter using this schema.

Required Fields

• title: human-readable page title
• persona: one of customer, company, association, all, authors
• version_introduced: semantic docs stream version (1.0, 1.1)
• last_reviewed: ISO date (YYYY-MM-DD)
• owners: list of owning teams

Optional Fields

• scope: platform (default) or specific module scope
• deprecates: version where this page supersedes older guidance
• related_services: backend/frontend services linked to content
• change_ticket: change request reference

Example

---
title: Cargo Lifecycle
persona: company
version_introduced: 1.0
last_reviewed: 2026-02-24
owners:
  - cargo-domain
  - company-portal-team
related_services:
  - core-backend
  - company-portal
---