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

Placing glossary at the document start could make a new reader feel unwelcome #159

Open
pmjordan opened this issue Jan 2, 2024 · 2 comments

Comments

@pmjordan
Copy link
Contributor

pmjordan commented Jan 2, 2024

I was trying to read the csd6 as a new reader. The first item I come across is a glossary containg a number of similar, interrelated terms with no context. This may have the effect of making the document more complex than necessary.
I suggest moving the glossary to the end of the overview section.

@lauwers
Copy link
Contributor

lauwers commented Jan 5, 2024

What I would prefer to do instead is to beef up the metamodel section of the document. That section should clearly define the terms that are currently in the glossary. We may no longer need the glossary section if we have a strong metamodel section.

@pmjordan
Copy link
Contributor Author

pmjordan commented Jan 5, 2024

Fine, I just want to ensure the reader gets a gentle introduction.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants