EventCatalog Documentation Creator
0This skill generates well-structured EventCatalog documentation files based on existing projects. It's designed for users who need to document EventCatalog projects following best practices.
1100Updated Yesterday
Documentation
Quick InstallView Source
$ npx skills add https://github.com/event-catalog/skills --skill catalog-documentation-creatorOverview
About This Skill
The EventCatalog Documentation Creator skill automates the generation of properly formatted EventCatalog documentation files, including services, agents, events, commands, queries, domains, flows, channels, and containers. It handles frontmatter configuration and folder structure according to EventCatalog best practices, eliminating manual setup overhead. This skill works standalone or as part of a larger documentation workflow—you can document individual services and events directly, or feed it output from the code-to-catalog skill for comprehensive architectural documentation. It's ideal for teams building event-driven systems who need consistent, standards-compliant documentation without manual file scaffolding.
How to Use
Install using the command `$ npx skills add https://github.com/event-catalog/skills --skill catalog-documentation-creator`
Use Cases
Generate documentation for new EventCatalog projects
Update existing EventCatalog documentation
Verify if a repository is structured as an EventCatalog project
Tags
Setup & Installation
Quick Install
Terminal
$ npx skills add https://github.com/event-catalog/skills --skill catalog-documentation-creatorAlternative Install (Git Clone)
git clone https://github.com/event-catalog/skillsRequirements
- Claude Code or compatible AI agent
Quick Start Guide
1
Install the Skill
Copy the install command above and run it in your terminal.
2
Open Your AI Agent
Launch Claude Code, Cursor, or your preferred AI coding agent.
3
Try It Out
Use the prompt template or examples below to test the skill.
4
Customize
Adapt the skill to your specific use case and workflow.
Usage Examples
Prompt Template
Generate comprehensive EventCatalog documentation for a project in [COMPANY]'s [INDUSTRY] domain. Include domain events, commands, queries, and aggregates. Use the following project structure: [DATA]. Ensure the documentation follows EventCatalog best practices and includes clear descriptions, versioning, and relationships between components. Format the output as a ready-to-use EventCatalog markdown file.
Example Output
# EventCatalog Documentation for Acme Corp's E-Commerce Platform
## Overview
This documentation describes the event-driven architecture of Acme Corp's E-Commerce Platform, implemented using EventCatalog. The system handles order management, inventory updates, and customer notifications through a series of domain events, commands, and aggregates.
## Domain Events
### OrderPlaced
- **Description**: Triggered when a customer successfully places an order.
- **Version**: 1.0.0
- **Payload**:
```json
{
"orderId": "string",
"customerId": "string",
"items": ["array"],
"totalAmount": "number"
}
```
- **Related to**: `OrderAggregate`
### InventoryUpdated
- **Description**: Published when inventory levels change due to order fulfillment or restocking.
- **Version**: 2.0.1
- **Payload**:
```json
{
"productId": "string",
"quantityChange": "number",
"newStockLevel": "number"
}
```
## Commands
### PlaceOrder
- **Description**: Initiates the order placement process.
- **Expected Events**: `OrderPlaced`, `PaymentProcessed`
- **Handler**: `OrderCommandHandler`
### UpdateInventory
- **Description**: Adjusts inventory levels based on order fulfillment or restocking.
- **Expected Events**: `InventoryUpdated`
- **Handler**: `InventoryCommandHandler`
## Aggregates
### OrderAggregate
- **Description**: Manages the lifecycle of an order from placement to fulfillment.
- **State**: `OrderState`
- **Commands**: `PlaceOrder`, `CancelOrder`
- **Events**: `OrderPlaced`, `OrderFulfilled`, `OrderCancelled`
## Relationships
- `PlaceOrder` command → `OrderPlaced` event → `OrderAggregate` state change
- `UpdateInventory` command → `InventoryUpdated` event → `ProductAggregate` state change
---
*Generated by EventCatalog Documentation Creator*
*Last updated: 2023-11-15*Find the right skills for your stack
Take a free 3-minute scan and get personalized AI skill recommendations.
Take free scan