liveBook · Manning

Ubiquitous language

As explained in Automating API Delivery

Ubiquitous language is a shared vocabulary used consistently by a development team and domain stakeholders to describe a domain and its software.

Ubiquitous language is a shared, rigorous vocabulary that development teams, domain experts, and users use consistently to describe domain concepts and the software representing them. section 5.1

For APIs, apply the vocabulary to the web resource model, operations, attributes, documentation, and examples. Reviewers identify unclear or inconsistent terminology and discuss differences with colleagues before approval. section 5.2.5

Use the language during API design review to check that:

  • Resource and attribute names match the accepted domain model. section 5.2.5
  • Operations and resources remain within the appropriate API boundary. section 5.2.5
  • Descriptions, summaries, and examples communicate the intended goal and user job clearly to integrating developers. section 5.2.5
  • Terms retain consistent meanings inside each bounded context. section 5.1

Resolving API terminology

While reviewing a pull request, compare resource and attribute names with the domain model. Flag unclear or inconsistent names, then discuss the terminology with colleagues so the API and its documentation use the agreed vocabulary. section 5.2.5

How Automating API Delivery covers it

How deep it goes
Defines shared domain vocabulary and applies it to API review, but does not prescribe a separate vocabulary-management process.
Examples
Uses resource names, attribute names, rendered API documentation, descriptions, and example values as terminology checkpoints.
What you can do after
Evaluate API terminology for consistency with the domain model and communicate corrections through design-review comments.
How it connects
Connects domain-driven design, domain models, bounded contexts, API design, and API documentation.

Also explained in

Compare how 4 books explain ubiquitous language →

Related concepts

This explainer was generated by Manning's knowledge graph from the text of Automating API Delivery. The section links point to the parts of the book it draws on.