TYPO3 Core

Is it possible to have a centralized glossary in a structured format which can also be synchronized with Crowdin?

How can we proceed with defining new terms and improving terms?

We have glossaries already, (see below), difficulty is to have a central glossary, who maintains it, who decides about terms when new things are introduced (or old terms are improved).

Suggestion¶

Have glossary in core repo, so definitions will be added early. Or some way to make decisions about new terms early, ideally while docs and core is written and not afterwards.

Requirements¶

The topic is a little complex, as there are several applications (or use cases), each with a little different requirements.

These points partially overlap!

Applications for glossaries:

1. (technical) a glossary for defining how a term is used and what it means, preferred spelling. This is not so much for end users, but rather for people writing documentation, writing and coding in core.
2. (BE user, translations in Crowdin): For some of the term definition this is relevant for translations too, but the scope is different: mostly backend user, not developer, so different terms and sometimes (slightly) different meanings.
3. Terms to be displayed in backend and for user (microcopy) which should be optimized for usability
4. Explains things to a person new to TYPO3 world - this is not as much scope of this issue but important too.

Workflow - how should workflow be for deciding / improving terms? It is often difficult to find results, because many things must be considered. Are there some general decisions we can make, general rules we can apply to terms to make this easier?

Existing glossaries:¶

• the official writing guide: https://guides.openstrategypartners.com/typo3-guide/writing-principles-and-guidelines/spelling-and-typo3-terminology
• Writing Documentation in Styleguide for Documentation: https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/GeneralConventions/Glossary.html
• Crowdin: https://crowdin.com/translate/typo3-cms/1892/en-de?filter=basic&value=0