Difference between revisions of "Help:Consistent writing"

From CompetenceBase
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
  
==Capitalisation and punctuation in items and properties==
+
==Syntax, capitalisation and punctuation in items and properties==
 
To ensure a consistent and readable data systems, we need some rules and writing hygiene in the way we add information.
 
To ensure a consistent and readable data systems, we need some rules and writing hygiene in the way we add information.
  
Line 9: Line 9:
 
It is '''not capitalised''', except when the first word is always capitalised, such as a personal name or abbreviation (or nouns in the German language), and it does '''not end in a full stop'''.
 
It is '''not capitalised''', except when the first word is always capitalised, such as a personal name or abbreviation (or nouns in the German language), and it does '''not end in a full stop'''.
  
'''Description''' is a an imperative or infinitive phrase (whatever is more appropriate for the language), or two.<br>
+
'''Description''' is a an imperative or infinitive phrase (whatever is more appropriate for the language), and optionally a second sentence for context.<br>
It is '''capitalized''' at the beginning, and '''ends in a full stop'''.
+
Each sentence is '''capitalized''' at the beginning, and '''ends in a full stop'''.
  
 
''For an example, see the ESCO competence '''Technically design a sound system''' in the [https://esco.ec.europa.eu/en/classification/skills?uri=http%3A//data.europa.eu/esco/skill/6cad4013-3055-47ba-8316-0720e1a55256 English], [https://esco.ec.europa.eu/nl/classification/skills?uri=http%3A//data.europa.eu/esco/skill/6cad4013-3055-47ba-8316-0720e1a55256 Dutch] and [https://esco.ec.europa.eu/de/classification/skills?uri=http%3A//data.europa.eu/esco/skill/6cad4013-3055-47ba-8316-0720e1a55256 German] versions:''
 
''For an example, see the ESCO competence '''Technically design a sound system''' in the [https://esco.ec.europa.eu/en/classification/skills?uri=http%3A//data.europa.eu/esco/skill/6cad4013-3055-47ba-8316-0720e1a55256 English], [https://esco.ec.europa.eu/nl/classification/skills?uri=http%3A//data.europa.eu/esco/skill/6cad4013-3055-47ba-8316-0720e1a55256 Dutch] and [https://esco.ec.europa.eu/de/classification/skills?uri=http%3A//data.europa.eu/esco/skill/6cad4013-3055-47ba-8316-0720e1a55256 German] versions:''
Line 60: Line 60:
 
|}
 
|}
  
===Knowledge details===
+
===Knowledge unit===
''Until further notice, each knowledge detail label should begin with the name of its knowledge subfield, followed by a slash, followed by the actual label, as follows: 'Mixing console/Gain structure and metering'.''<br>
+
''Until further notice, each knowledge label should begin with the name of its knowledge subfield, followed by a slash, followed by the actual label, as follows: 'Mixing console/Gain structure and metering'.''<br>
 
Label and description formats are the same as for ''knowledge fields''.
 
Label and description formats are the same as for ''knowledge fields''.
  
The '''context''' field should be used to give more extensive context information in one or more full, grammatically correct sentences, such as why this detail is important or what role it plays in the understanding important concepts or in the practice of sound engineering.
+
The '''context''' field should be used to give more extensive context information in one or more full, grammatically correct sentences, such as why this knowledge unit is important or what role it plays in the understanding important concepts or in the practice of sound engineering.
  
 
''For an example, see [[Item:Q913]]:''
 
''For an example, see [[Item:Q913]]:''
Line 77: Line 77:
 
| DE || Mischpult/Signalfluss || der Weg des Signals durch das Mischpult, seine verschiedenen Bus-Typen und Routing-Möglichkeiten
 
| DE || Mischpult/Signalfluss || der Weg des Signals durch das Mischpult, seine verschiedenen Bus-Typen und Routing-Möglichkeiten
 
|}
 
|}
 +
 +
===Knowledge detail===
 +
A short, concise, '''non-capitalized''' term '''without full-stop'''. Two-letter ISO language code must be specified!
 +
 +
''Examples: "signal flow", "types of busses and their application", ...
 +
 +
===Knowledge content===
 +
A list of concrete learning outcomes contained in each knowledge detail, and formatted and language-coded like one.
 +
 +
This level of detail is optional and should only be used as necessary.

Latest revision as of 13:31, 29 July 2024

Syntax, capitalisation and punctuation in items and properties

To ensure a consistent and readable data systems, we need some rules and writing hygiene in the way we add information.

Competences

This rule is for consistency with ESCO:

Label is a an infinitive or imperative phrase (whatever is more appropriate for the language).
It is not capitalised, except when the first word is always capitalised, such as a personal name or abbreviation (or nouns in the German language), and it does not end in a full stop.

Description is a an imperative or infinitive phrase (whatever is more appropriate for the language), and optionally a second sentence for context.
Each sentence is capitalized at the beginning, and ends in a full stop.

For an example, see the ESCO competence Technically design a sound system in the English, Dutch and German versions:

ISO Label Description
EN technically design a sound system Set up, test and operate a complex audio system, based on a given sound concept. This could be a permanent as well as a temporary installation.
NL geluidssysteem technisch ontwerpen Het opzetten, testen en bedienen van een complex audiosysteem dat gebaseerd is op een gegeven geluidsconcept. Dit kan zowel een permanente als een tijdelijke installatie zijn.
DE technischen Entwurf für ein Soundsystem anfertigen Einrichten, Testen und Bedienen eines komplexen Audiosystems auf der Grundlage eines Soundkonzepts. Dabei könnte es sich um eine ständige oder eine vorübergehende Einrichtung handeln.

Knowledge fields

Label is a usually single noun with at most 2-3 additional explanatory terms.
It is capitalized as a headline to make it stand out as a category identifier, and it does not end in a full stop.

Description is a short nominal phrase with optionally a few subclauses.
It is not capitalized, and does not end in a full stop.

For an example, see Item:Q851:

ISO Label Description
EN Sound theoretical and applied knowledge on sound and sound engineering
NL Geluid theoretische en toegepaste kennis op het gebied van geluid en geluidstechniek
DE Ton theoretisches und angewandtes Wissen im Bereich Ton und Tontechnik

Knowledge subfields

Until further notice, each subfield label should begin with the name of its knowledge field, followed by a space, a dash, and another space, as follows: 'Sound - Mixing console'.
Label and description formats are the same as for knowledge fields.

For an example, see Item:Q868:

ISO Label Description
EN Sound - Mixing console the theoretical and applied knowledge about the functioning and use of sound mixing desks
NL Geluid - Mengpaneel de theoretische en toegepaste kennis over de werking en het gebruik van geluidsmengtafels
DE Ton - Mischpult Grund- und Praxiswissen über die Funktion und den Gebrauch von Mischpulten

Knowledge unit

Until further notice, each knowledge label should begin with the name of its knowledge subfield, followed by a slash, followed by the actual label, as follows: 'Mixing console/Gain structure and metering'.
Label and description formats are the same as for knowledge fields.

The context field should be used to give more extensive context information in one or more full, grammatically correct sentences, such as why this knowledge unit is important or what role it plays in the understanding important concepts or in the practice of sound engineering.

For an example, see Item:Q913:

ISO Label Description
EN Mixing console/Signal flow the path of the signal through the mixing desk, its different bus types and routing options
NL
DE Mischpult/Signalfluss der Weg des Signals durch das Mischpult, seine verschiedenen Bus-Typen und Routing-Möglichkeiten

Knowledge detail

A short, concise, non-capitalized term without full-stop. Two-letter ISO language code must be specified!

Examples: "signal flow", "types of busses and their application", ...

Knowledge content

A list of concrete learning outcomes contained in each knowledge detail, and formatted and language-coded like one.

This level of detail is optional and should only be used as necessary.

Wikidata