MuseScore 4 handbook update: contributions sought!
As we prepare for the release of MuseScore 4, we’d like to invite our community to participate in generating the documentation that will form our online handbook, available here on musescore.org.
Marc Sabatella, Peter Jonas and I have been working for several months to prepare a new version of the online handbook that’s both comprehensive and user-friendly. While a few elements are still being implemented, the overall chapter structure has now been established, including section sub-headings on most pages to help contributors organise the necessary content in a logical and easy-to-understand way.
We’ve made a bunch of styling changes to improve the handbook’s appearance and legibility, and are making better use of visual media (including GIFs) to show how MuseScore 4 works. We’ve also put together a helpful page of guidelines for contributors so that together, we can create a cohesive and well-written document.
The MuseScore 4 handbook will go together with a new series of videos on YouTube (also accessible from within the desktop app itself) to form a comprehensive and engaging multimedia resource.
If you enjoy writing, assembling visual content, structuring detailed information in simple and logical ways, and are keen to make a lasting contribution to what is shaping-up to be a groundbreaking release in the music software world, then we invite you to participate as a contributor to the MuseScore 4 handbook.
How to contribute
You’ll need a free account to edit pages on musescore.org. If you don’t already have one, you can create one here.
Next, we ask you to please read the page Editing the handbook.
If you then have any questions, please post them in the Documentation forum.
Next, head over to the MuseScore 4 handbook landing page. Because the handbook is still in draft status, we haven’t yet published this page at its final destination URL. This will happen at the same time as the stable release of MuseScore 4.
We recommend perusing the pages that we’ve created. You’ll find that some have already been filled with content (For example, Create your first score, Working with instruments, and the page about the Mixer). Use these as a guide to the kind of writing style and use of visual media we are looking for.
When you find a page that interests you and hasn’t already been written (It will probably contain sub-headings, but no actual content), then click on the “three dots” menu in the top right corner of the page and select “Edit”.
In addition to the guidelines we have published in Editing the handbook, please keep the following in mind:
- The handbook is written using Markdown. If you’re not familiar with this style, we recommend reading this page first (Note: You’ll need a musescore.com account to properly view this page).
- A handy option for auto-generating your content in Markdown is to first draft it in Google Docs, then use the free Docs to Markdown plugin to generate the required script, which you can simply paste into the Edit page.
- Whenever you make any contributions or changes to a page, please briefly note these changes (one or two lines will do) in the Revision log message field, which you’ll find in the Published panel on the right side of every Edit page.
Our team, with editorial oversight provided by Marc Sabatella and myself, will be reviewing changes as they are made. We may from time to time need to make adjustments to your content if something needs correcting, or if we’ve found a way to better articulate something in the context of the overall tone of the handbook.
Again, if you have any questions, please post them in the Documentation forum, or in the comments below. We look forward to working with you to build this valuable resource for the latest release of MuseScore.