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¶
- Keep catalog entries DRY - single source of truth
- Use machine-readable formats where possible (JSON Schema, OpenAPI)
- Version catalog entries when breaking changes occur
- Link to catalogs from operational docs rather than copying