preferences-event-catalog-tooling

Formalize domain events, commands, and services into EventCatalog documentation.

14|Updated May 28, 2024
One-click install
npx skills add https://github.com/cameronraysmith/vanixiets --skill preferences-event-catalog-tooling
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: preferences-event-catalog-tooling
Source: https://github.com/cameronraysmith/vanixiets/tree/main/modules/home/ai/skills/src/core/preferences-event-catalog-tooling
Command: npx skills add https://github.com/cameronraysmith/vanixiets --skill preferences-event-catalog-tooling

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill formalizes domain events, commands, and services into structured, queryable documentation, ensuring a consistent system of record for event-driven architectures.

Core Features & Use Cases

  • Event Documentation: Captures algebraic properties of events, including schema, producers, and consumers.
  • Command Documentation: Documents functional semantics of commands, including validation rules and emitted events.
  • Service Documentation: Defines module boundaries with explicit effect signatures.
  • Use Case: Automatically generate and maintain a living documentation site for your event-driven system using EventCatalog, ensuring all teams have a clear understanding of the event landscape.

Quick Start

Use the preferences-event-catalog-tooling skill to document the 'order-placed' event.

Frequently Asked Questions about preferences-event-catalog-tooling

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I document domain events and commands for an event-driven architecture?

You document domain events by capturing their algebraic properties, including schemas, producers, and consumers, into a structured, queryable system of record. This formalizes event-driven architecture documentation and creates a living reference site.

What is the best way to maintain a living documentation site for an event catalog?

Maintain a living event catalog by formalizing domain events, commands, and services into structured, queryable documentation using EventCatalog. This enforces schema governance through additive versioning and integrates with EventStorming artifacts.

How does EventStorming integration work with event catalog tooling?

EventStorming integration works with event catalog tooling by taking EventStorming artifacts and formalizing them into structured, queryable documentation. This process captures event schemas, command signatures, and service boundaries for event-driven architectures.

Can I enforce schema governance and additive versioning for domain events?

Yes, you can enforce schema governance for domain events through additive versioning. This maintains a consistent system of record by formalizing event schemas, command signatures, and service effect boundaries into structured documentation.

How do I document service boundaries and effect signatures in an event catalog?

Document service boundaries by defining explicit module boundaries with effect signatures in the event catalog. This formalizes services alongside domain events and commands, creating a structured, queryable system of record for event-driven architectures.

When do I need to formalize event schemas and command signatures?

You need to formalize event schemas and command signatures when building an event-driven architecture that requires a consistent system of record. This approach supports algebraic functional domain modeling and integrates with EventStorming artifacts.