Skip to content

Catalogs

Data dictionaries, API specifications, and technical reference materials.

What Goes Here

Catalog documentation includes: - Data dictionaries and schemas - API specifications (OpenAPI, GraphQL schemas) - Event catalogs - Service registries - Configuration references - Enum definitions and constants

Purpose

Catalogs provide canonical definitions of: - Data structures and types - API contracts - Event formats - Configuration options

These are reference materials that other documentation points to rather than duplicating.

Best Practices

  1. Keep catalog entries DRY - single source of truth
  2. Use machine-readable formats where possible (JSON Schema, OpenAPI)
  3. Version catalog entries when breaking changes occur
  4. Link to catalogs from operational docs rather than copying