3 Language

This section contains editorial rules on content and language:

Section 3.1, “Use American English (ASM-49)”
Section 3.2, “Note the spell check results (ASM-17)”
Section 3.3, “Use present tense (ASM-62)”
Section 3.4, “Use active voice (ASM-63)”
Section 3.5, “Use an Oxford comma (ASM-33)”
Section 3.6, “Add a comma after introductory phrases (ASM-123)”
Section 3.7, “Capitalization after colons (ASM-126)”
Section 3.8, “Use simple phrases (ASM-64)”
Section 3.9, “Use concise phrases (ASM-67)”
Section 3.10, “Write short sentences (ASM-61)”
Section 3.11, “Use complete expressions instead of abbreviations (ASM-65)”
Section 3.12, “Do not use slashes for conjunctions (ASM-122)”
Section 3.13, “Do not use synonyms (ASM-66)”
Section 3.14, “Use 'that' for essential information (ASM-68)”
Section 3.15, “Use 'which' for additional information (ASM-115)”
Section 3.16, “Use 'since' to refer to a point in time (ASM-69)”
Section 3.17, “Use 'because' to express a reason (ASM-116)”

3.1 Use American English (ASM-49)

The default language is American English.
Use the Merriam Webster Dictionary to check for correct spelling.

Exceptions

There are no exceptions.

Example

Table 12. Use of American English
No	Yes
colour	color
labelling	labeling
analyse	analyze
centre	center

Source

ASAM specific rule.

3.2 Note the spell check results (ASM-17)

The production pipeline performs a general spell check on all files.
Check the results of the production pipeline for spelling errors.

Exceptions

There are no exceptions.

Example

code.asam.net/simulation/opendrive-group/opendrive-standard/-/jobs/20219

Source

ASAM specific rule.

3.3 Use present tense (ASM-62)

Exceptions

There are no exceptions.

Example

Table 13. Use of present tense
No	Yes
Variable x will contain the value.	Variable x contains the value.

Source

ASAM specific rule.

3.4 Use active voice (ASM-63)

Use the acting object as the subject of a sentence.

Exceptions

There are no exceptions.

Example

Table 14. Use of active voice
No	Yes
The variable is set by the user.	The user sets the variable.

Source

ASAM specific rule.

3.5 Use an Oxford comma (ASM-33)

Use a comma before a conjunction in an enumeration.
Separate also the last noun in a list from the rest of the list using a comma.

Exceptions

There are no exceptions.

Example

Table 15. Use an Oxford comma
No	Yes
Unless stated otherwise, all examples, figures and descriptions in this specification assume there is right-hand traffic.	Unless stated otherwise, all examples, figures, and descriptions in this specification assume there is right-hand traffic.
Pages, colors, traces are all copied from the display.	Pages, colors, and traces are all copied from the display.

Source

tekom English for Non-Native Writers, 2. updated edition, Rule EN_S 610, S. 76, Place a Comma in Front of Conjunctions in Enumerations

3.6 Add a comma after introductory phrases (ASM-123)

Add a comma after introductory phrases, for example, prepositional phrases and infinitive phrases. This improves the readability and understandability of sentences.

Exceptions

There are no exceptions.

Example

Table 16. Add a comma after introductory phrases
No	Yes
In the ASAM OpenSCENARIO data model these types are used:	In the ASAM OpenSCENARIO data model, these types are used:
To find the mismatches we propagate the expected type backwards through the expression.	To find the mismatches, we propagate the expected type backwards through the expression.

Source

ASAM specific rule.

3.7 Capitalization after colons (ASM-126)

Use lower case after a colon, if individual words or phrases follow.
Use upper case after a colon, if a complete sentence follows.

Exceptions

There are no exceptions.

Example

Table 17. Capitalization after colons
No	Yes
Power consumption: Approximately 160 VA	Power consumption: approximately 160 VA
Setting the language: press the F4 key.	Setting the language: Press the F4 key.

Source

tekom English for Non-Native Writers, 2. updated edition, Rule EN_W 502, Page 87, Colons

3.8 Use simple phrases (ASM-64)

Leave out paraphrases.

Exceptions

There are no exceptions.

Example

Table 18. Use of simple phrases
No	Yes
in order to	to
has the possibility to	can

Source

ASAM specific rule.

3.9 Use concise phrases (ASM-67)

Leave out filler words.

Exceptions

There are no exceptions.

Example

Table 19. Use of concise phrases without unnecessary words
No	Yes
This is really a transition from the byte orientation in UDS to a very user-friendly symbolic access to the required data.	This is a transition from the byte orientation in UDS to user-friendly symbolic access to the required data.

Source

ASAM specific rule.

3.10 Write short sentences (ASM-61)

Split long sentences into shorter sentences.

Exceptions

There are no exceptions.

Example

Table 20. Use of short sentences
No	Yes
Tool vendors and suppliers who wanted to develop an iLinkRT V2.0 MC-Client / MC-Server had to implement another ASAM standard ASAP3 if a remote configuration of iLinkRT channels was requested, as this was done via ASAP3. Other functionalities were only available via ASAP3 at all. This made it particularly difficult for those who had not previously developed an ASAP3 interface.	The MC-Client or MC-Server implementation of iLinkRT V.2.0 requires an independent remote configuration channel. Typically, ASAP3 is used for this task. Functionally not covered by iLinkRT V2.0 is also available via ASAP3. This made it particularly difficult for those who had not previously developed an ASAP3 interface.

Source

ASAM specific rule.

3.11 Use complete expressions instead of abbreviations (ASM-65)

Exceptions

There are no exceptions.

Example

Table 21. Use of complete expressions instead of abbreviations
No	Yes
e.g.	for example
i.e.	meaning
etc.	and so on

Source

ASAM specific rule.

3.12 Do not use slashes for conjunctions (ASM-122)

Do not use slashes (/) for conjunctions.
Write out conjunctions. This improves the understandability.

Exceptions

In case of limited space, for example, in table headers, a slash can be used as a replacement for the conjunction or.

Example

Table 22. Do not use slashes for conjunctions
No	Yes
parameters/attributes	parameters or attributes
lateral and/or longitudinal	lateral, longitudinal, or both
segment continuity, tangent and/or curvature continuity	segment continuity, tangent, curvature continuity, or all of them

Source

ASAM specific rule.

3.13 Do not use synonyms (ASM-66)

Use the same word for the same object or concept.

Exceptions

There are no exceptions.

Example

Table 23. Use of the same word for the same object or concept
No	Yes
Press and hold the key. Wait 2 seconds. Release the button. Push the button again.	Press and hold the key. Wait 2 seconds. Release the key. Press the key again.

Source

ASAM specific rule.

3.14 Use 'that' for essential information (ASM-68)

Use 'that' to insert essential information.
Do not use commas.

Exceptions

There are no exceptions.

Example

Table 24. Use of 'that' for essential information
No	Yes
The car they own is old.	The car that they own is old.
The car which they own is old.	The car that they own is old.
The car, that they own, is old.	The car that they own is old.

Source

ASAM specific rule.

3.15 Use 'which' for additional information (ASM-115)

Use 'which' to insert additional information that can be left out.
Use commas.

Exceptions

There are no exceptions.

Example

Table 25. Use of 'which' for unessential color information
No	Yes
The car that is red drives down the road.	The car, which is red, drives down the road.
The car which is red drives down the road.	The car, which is red, drives down the road.

Source

ASAM specific rule.

3.16 Use 'since' to refer to a point in time (ASM-69)

Exceptions

There are no exceptions.

Example

Table 26. Use of 'since' to refer to a point in time
No	Yes
Since the Diagnostic Port API supports functional groups, the client can read data from a functional group.	The Diagnostic Port API supports functional groups. This allows the client to read data from a functional group.

Source

ASAM specific rule.

3.17 Use 'because' to express a reason (ASM-116)

Exceptions

There are no exceptions.

Example

Table 27. Use of 'because' to refer to a reason
No	Yes
Since this kind of information highly depends on the implementation technology there are different reference elements for CSharp and Python classes.	Different reference elements for CSharp and Python classes exist, because this kind of information highly depends on the implementation technology.

Source

ASAM specific rule.