Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MSC4270: Matrix Glossary #4270

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

MSC4270: Matrix Glossary #4270

wants to merge 2 commits into from

Conversation

turt2live
Copy link
Member

Rendered


I am Director of Standards Development at The Matrix.org Foundation C.I.C., Matrix Spec Core Team (SCT) member, employed by Element, and operate the t2bot.io service. This proposal is written and published with my role as a member of the SCT.

@turt2live turt2live changed the title MSC: Matrix Glossary MSC4270: Matrix Glossary Feb 26, 2025
@turt2live turt2live marked this pull request as ready for review February 26, 2025 22:07
@turt2live turt2live added proposal A matrix spec change proposal meta Something that is not a spec change/request and is not related to the build tools kind:core MSC which is critical to the protocol's success labels Feb 26, 2025
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Implementation requirements:

  • None feasible

Comment on lines +97 to +100
* UK English
* US English (where different from UK English)
* French
* German
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this list is very much an open question

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe the selection could be supported by usage statistics from clients (where those exist)?

* French
* German

## Potential issues
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The SCT not having native speakers for all supported languages creates the risk of low-quality or, though less likely, harmful translations creeping in. I think this proposal should provide more detail around how the SCT will prevent this. Paid translation services alone don't feel like a great solution because those will most likely not have any understanding of Matrix technicalities. Maybe we could use trusted native community members or a community voting scheme for reviewing the translations.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given updates to translations would need to be done via MSCs, i'd have thought we can require that FCP will only pass once a trusted reviewer who natively speaks the language has signed it off. Trust could mean professional translator, or a community member who's accrued trust, etc.

Comment on lines +22 to +23
* To define words, phrases, and terminology that implementations SHOULD use to provide consistent
user experience, especially when users are switching between implementations.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be helpful to clarify whether this includes only end users or everyone interfacing with an implementation (such as server admins). I suppose "user" here is meant to be user as defined in the glossary itself?


## Proposal

A new specification document titled "Glossary" is established, residing next to or near the existing
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the term "glossary" doesn't make it clear enough that these terms are supposed to be used in a client's UI – especially because the spec currently contains mostly technical requirements and only very few things that impact UI or UX. As somebody implementing the spec I might mistake this section as something that is supposed to help me understand the spec and neglect it. Maybe "End user glossary" or something similar would be better?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tbh reading this so far i assumed that this is going to just be an appendix in spec for the words used in spec... I never even assumed this would be about enduser communication 🤔 so imho its definetly not clear if it is enduser (aka client user, sdk user,...) or people directly implementing from spec (devs building an sdk, writing a hs or similar)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah, agreed. I wonder if this whole thing should be renamed "Consistent user-facing terminology" to make it clear on what we're trying to solve? It then means that encryption-specific terminology as per #4161 will also be less out of place.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The key thing being that we're trying to define consistent terms so that if users mix clients, they don't get completely lost (how come fluffychat is prompting me to enter a security code, but element x is prompting me to enter a recovery passphrase? or whatever)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sounds better than "glossary" to me. 👍

It'll require two lines in the menu .. but I'm not sure that really matters.

Screenshot 2025-03-04 at 20 11 49

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:core MSC which is critical to the protocol's success meta Something that is not a spec change/request and is not related to the build tools proposal A matrix spec change proposal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants