kata-feature-design-docs

Generate and update feature design docs for entities, OpenAPI specs, and CloudEvents.

Updated Sep 3, 2025
One-click install
npx skills add https://github.com/guardiatechnology/design-system --skill kata-feature-design-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: kata-feature-design-docs
Source: https://github.com/guardiatechnology/design-system/tree/main/.claude/skills/kata-feature-design-docs
Command: npx skills add https://github.com/guardiatechnology/design-system --skill kata-feature-design-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

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/.

Frequently Asked Questions about kata-feature-design-docs

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

FAQPage Schema
How do I generate feature design documentation for DDD entities and OpenAPI specs?

Feature design documentation for DDD entities and OpenAPI specs is generated by applying bounded-context conventions and category templates to output canonical files with preserved cross-references. It produces entity files, OpenAPI 3.x definitions, and CloudEvents catalogs under the correct docs path.

What is the best way to keep CloudEvents documentation and OpenAPI specs consistent across bounded contexts?

Keeping CloudEvents documentation and OpenAPI specs consistent across bounded contexts requires enforcing canonical folder structures, filenames, and template conformance during the feature design cycle. This approach validates naming rules and outputs aligned per-context events catalogs and entity lifecycle diagrams.

How do I create OpenAPI definitions that align with my bounded context and domain entities?

To create OpenAPI definitions aligned with your bounded context, generate specifications using category templates that enforce paths ordering, schemas, parameters, and auth/idempotency headers. This ensures the generated OAS documents match the bounded context conventions and reference the correct DDD entities.

Does this feature design doc generation enforce folder structure and template conformance for domain entities?

Yes, feature design doc generation enforces canonical folder structure and filenames while validating conformance to Lexis/Codex rules. It ensures DDD-classified entity files include fields, business rules, invariants, and relationships correctly structured within the specified docs directory.

When do I need to generate per-context events catalogs and entity lifecycle state diagrams?

You need to generate per-context events catalogs and entity lifecycle state diagrams when creating or modifying published CloudEvents for a bounded context. This process writes full CloudEvents payload examples and idempotency notes to maintain accurate event documentation during feature design.

Why does my feature design documentation lose cross-references between entities, OpenAPI, and events?

Feature design documentation loses cross-references when files are created without enforcing canonical paths and template conformance. Generating entities, OpenAPI specs, and CloudEvents docs through bounded-context conventions validates structure and outputs the required documents with cross-references preserved.