kata-events-doc

What problem does it solve?

This Skill solves the problem of inconsistent, incomplete event documentation by generating a canonical CloudEvents events.md file that precisely matches your module’s event catalog, payload shape, and idempotency requirements.

Core Features & Use Cases

• CloudEvents-accurate documentation: Produces event entries with required CloudEvents fields (type, source, subject, idempotencykey, data) and properly structured JSON examples.
• Entity-aligned payloads: Documents each event’s data payload using your codex-entities field definitions (with history omitted as required).
• Idempotency-focused event specs: Ensures every event documents idempotencykey so consumers can deduplicate reliably.
• Use Case: When a bounded context emits multiple lifecycle events (created/updated/cancelled), this Skill documents them for downstream teams to integrate without ambiguity.

Quick Start

Ask the Skill to generate or update docs/{context}/events/events.md for your bounded context and module, using the existing entities under docs/{context}/entities and the CloudEvents and idempotency directives.