Generated with ❤ by hubiFork me on GitHub
Domain File(A.K.A Configuration File)

An YAML file containing information about a particular piece of the ubiquitous language.

ⓘ Not all domain files translate to source files due to the "abstract" configuration e.g. this very one! This can be useful when you're drafiting a model or even when you want to share it across different projects.

Ubiquitous Token(A.K.A TokenDomain ObjectObject ValueEntity)

A piece of the ubiquitous language extracted from its domain file

ⓘ It represents a phrase, expression, term, etc

Attributes Description Default
name: string How people refer to the token?Should be unique across the domain to avoid ambiguity
description: string A short sentence to teach/remind everyone what the token means?You're reading it right now
attributes: [Attribute]? A collection of attributes a token is associated with.?This collection is specially useful for developers and is where translators are expected to work more often. []
filePath: string The path to its file domain
abstract: boolean? A flag to inform translators if they should or not translate the token false
comment: string? An extra message, for developers, about the token null
aliases: [string]? Alternative names, abbreviations, etc?Other ways to refer to the token itself []
Attribute(A.K.A CharacteristicMember)

A token's characteristic.

ⓘ Programming-wise, it is an object's member.

Attributes Description Default
name: string How the attribute is referenced relativelly to its token
type: string? What kind of token it is "string"
required: boolean? A flag to mark the attribute as required false
description: string? A short sentence to teach/remind everyone what that attribute means null
comment: string? An extra message, for developers, about the attribute?This very sentence is a comment itself null
Translation(A.K.A Result)

Holds information relevant to create/analyse source files in given translation

Attributes Description Default
lexicon: object The translation's vocabulary which is a collection of token-like objects?It is a map to be more precise
Translator(A.K.A Plugin)

Interpret the ubiquitous language's tokens in order to write source files automatically.

Attributes Description Default
interpretToken: (token:Ubiquitous Token) → object How each ubiquitous language's token is interpreted during translation?Like an interface for making translating possible
Ubiquitous Language(A.K.A Domain Language)

A common language for everybody

ⓘ Each translator will interpret its token diffetently

Attributes Description Default
tokens: [Ubiquitous Token] A collection of tokens