domain-language-types

Renames technical type identifiers to domain-aligned names.

Updated Jul 17, 2017
One-click install
npx skills add https://github.com/luyi985/lyi-bash --skill domain-language-types
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: domain-language-types
Source: https://github.com/luyi985/lyi-bash/tree/main/ai/skills/domain-language-types
Command: npx skills add https://github.com/luyi985/lyi-bash --skill domain-language-types

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Naming types is often domain-agnostic and hides business meaning, making it hard for domain experts to understand data models. This skill helps align type names with business terminology to improve clarity and collaboration.

Core Features & Use Cases

  • Prefer domain terms over technical structures to improve readability for domain experts.
  • Useful when naming new types or refactoring unclear names, and when reviewing APIs for domain alignment.
  • Example: rename a generic DataRecord to CustomerProfile or ProductCatalog to reflect business concepts.

Quick Start

Ask your AI to rename a provided type to a domain-appropriate name while preserving its shape.

Frequently Asked Questions about domain-language-types

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

FAQPage Schema
How do I rename technical type names to reflect domain concepts in my data models?

To rename type names to reflect domain concepts, you map technical identifiers to domain-aligned names, transforming generic structures like DataRecord into business terms like CustomerProfile to improve readability for domain experts.

What is the best way to improve API readability for domain experts during refactoring?

Improving API readability for domain experts involves replacing domain-agnostic technical structures with ubiquitous business terminology. This aligns data models with business concepts, making APIs clearer for non-technical stakeholders.

When should I align type naming conventions with domain language?

You should align type naming conventions with domain language when naming new types, refactoring unclear identifiers, or reviewing APIs. This ensures data models remain understandable to domain experts and accurately reflect business concepts.

Can I use domain-driven naming for existing code without changing the data model shape?

Yes, applying domain-driven naming preserves the underlying data model shape while outputting mappings from technical identifiers to domain-aligned names. This allows you to update type names without altering structural logic.

Why do generic type names make data models hard for domain experts to understand?

Generic type names hide business meaning because they are domain-agnostic and rely on technical structures. Aligning type names with domain language exposes the underlying business concepts, improving clarity and collaboration.

Do I need domain-language guidelines to refactor type names in my APIs?

Yes, refactoring type names in APIs requires adherence to domain-language guidelines. This ensures the mapped domain-aligned names accurately represent business concepts and maintain consistency across the data models.