What problem does it solve?
It prevents teams from producing inconsistent, incorrectly structured feature design documentation by enforcing canonical paths, templates, and cross-references throughout the feature design cycle.
Core Features & Use Cases
- Creates or updates entities documentation: generates DDD-classified entity files with fields, business rules, invariants, relationships, errors, and references.
- Creates or updates OpenAPI specifications: produces OpenAPI 3.x definitions aligned to the bounded context, including tags, paths ordering, schemas, parameters, and auth/idempotency headers.
- Creates or updates CloudEvents documentation: writes per-context events catalog and per-entity lifecycle state diagrams with full CloudEvents payload examples and idempotency/trigger notes.
- Use Case: During a ScheduledPayments feature design, generate the
entities/, oas/, and events/ documents under docs/scheduled-payments/ while validating naming, structure, and template conformance.
Quick Start
Use the kata-feature-design-docs skill to generate the entities, OpenAPI, and events documents for a bounded context named ScheduledPayments under docs/scheduled-payments/.