glossary vs. index

• Jun 11, 2018 - 18:37

Again and again there are requests with the same topic but not easy to find inside the handbook for new users. I wonder if it would be useful to extend the glossary with an index or create an additional index with hyperlinks therefore.

I think of requests like "hide staves", "add instruments", "add pages" and so on (there are definetively some more).


Comments

One problem with those FAQs is that, while the answer is always the same ("Use voices" or "Use Hide empty staves"), the questions are often very different, so however you spell it out, users won't find it.
Another problem is that many users don't read the documentation, so they won't even see it.

On the upside: these questions always give us a change for a warm welcome and the positive surprise of the users about the lightning fast replies.

In reply to by Jojo-Schmitz

Maybe you're right (especially with the "warm welcome" ;-).

And maybe there are different user behaviors (some are asking without reading the handbook or watching the introduction videos, other using a search engine and replying on an old thread ;-), other reading the handbook without find the correct answer (but as you mentioned, there's a fast reply inside this forum).

And it's only my personal view sight, by looking for a special topic inside a technical/specialist book, an index is very helpful for me to find the correct term.

Shortly, I will update the glossary (in English) to help make it easier to find items in the documentation. I plan to put hyperlinks that will allow the user to see the handbook where the instructions for the item exists and an external web page where additional information can be found on the subject. I also want the translations to keep the American English word in the glossary so non-native English searches will be easier in the forum. Not knowing the English word is often the biggest problem for others using the search function for their answers. The English version of the glossary will include terms in other forms of English to help people like the Brits to more easily find information on a measure (bar) for example.

My reasoning behind including the English word is that languages such a Spanish do not use the word quarter note or crotchet. In Spanish the word is the feminine form of the word Black. I have discovered a wide variety of words that just don't translate in music, so including the American English word in the translations of the glossary will be useful.

Of course there are two requirements for this to work. 1. The translators agree and do as I suggest. 2. Users actually read the manual. 2. is far more difficult to make happen than 1.

In reply to by mike320

Concernig. 2.: As mentioned above I see different user behavior and of course, not every user would use such an index.

But a little example and explanation from my user behavior, why it could useful to extend the glossary above musical terms/symbols. When I'm looking for a special request (to compare it with MuseScore) inside Lilypond (cross referencing), I'll soon find what I'm looking for with the index (http://lilypond.org/doc/v2.19/Documentation/notation/lilypond-index).

In reply to by kuwitt

Interesting index. It deserves some careful consideration.

How should it be included in MuseScore. Is there a way to put it in the online handbook but not include it in the PDF? Maybe it could have a multiple column layout that will make it take up fewer pages. Just some thoughts that come to my mind quickly.

In reply to by mike320

Not sure, my technical skills are limited ;-).

I don't use the pdf version, but it should be also possible to include hyperlinks inside a pdf file.

It doesn't need to work/to look like in the same way as in the Lilypond handbook.

My intention is to simplify MuseScore - inside the application but maybe also inside the handbook. A glossary means for me to explain the meaning of musical symbols or standards of a sound application (like the sfz file format).

An index extend it to key words above it (why should I know that I find the phrase "slash notation" in the tools chapter?)

I hope no one will see this as criticism, but more as a suggestion/inspiration ;-).

In reply to by kuwitt

I agree about it being a suggestion rather than criticism. My concern is that the index will be as long as the rest of the handbook. The downloaded handbook is quite long enough as it is. I see it as a very useful tool for online, but of far less use in the PDF version. Yes, the PDF internal links work, but I think someone searching for help would find the online index more useful than a downloadable one. Perhaps leaving the glossary to definitions (and the Engish word for all entries) and adding an index is a better way to go.

Do you still have an unanswered question? Please log in first to post your question.