Den gode brug af det danske og engelske sprog i forretningsdomæner (siloer)

Denne side beskriver de normerende principper for brugen af dansk og engelsk i STAR City. Formålet er at sikre ensartet navngivning og tydelige kontrakter mellem forretningsdomæner.

Retningslinjerne gælder for:

• udviklere

• arkitekter

• forretningsanalytikere

Alle regler på denne side er normative og skal følges i nye løsninger.

Sprogvalg følger systemets lag og kontrakter:

• Interne tekniske lag skal kodes på engelsk.

• Forretningsrettede kontrakter skal navngives på dansk.

• REST-services skal kodes på engelsk.

• Swagger-kontrakter skal udstilles på dansk.

• Danske navne i Swagger skal sikres via attributter eller metadata.

• Routes samt path- og query-parametre skal navngives på dansk.

Dette gælder:

• metodenavne

• parametre

• request- og response-DTO’er

• HTTP-templates

Se også: Den gode danske sniftlade i forretningsdomænerPreview

Følgende lag skal kodes på engelsk:

• forretningslogik

• domæneobjekter

• CQS features

• valideringsklasser

• hjælpeklasser

• data access

• databaseobjekter

Beskrivelser af tabeller og felter i databasen skal være på dansk.

• Events skal kodes og navngives på dansk.

• Dette gælder:

  • eventnavne

  • properties

  • eventkontrakter

Events er interne kontrakter mellem forretningsdomæner og skal derfor afspejle forretningens sprog.

• Kodelister skal navngives på dansk.

• Enum-navne må være på engelsk.

• Fejlkode-enum må være på engelsk.

• Fejlkodetekster skal være på dansk.

• Æ, ø og å må ikke anvendes i kompileret kode.

• I REST-snitflader erstattes:

  • æ med ae

  • ø med oe

  • å med aa