Éditer le Manuel

Guidelines for writing articles

Vous pourriez avoir envie de contribuer à l'écriture du Manuel de MuseScore 4 – super ! Et bienvenue.

Cette page résume les recommandations à suivre pour vous permettre de commencer à écrire des articles. Merci de la lire avec attention avant d’éditer quoi que ce soit dans notre Manuel. Ces informations sont destinées à vous aider mais, en cas de doute dans n’importe quel domaine, n’hésitez pas poser vos questions dans le forum Documentation.

Structure - General principles

Chaque page doit décrire un sujet de façon plus ou moins complète. Si vous sentez que la page devient trop longue, essayez de la diviser en pages séparées.

Toutes les pages ne sont pas identiques mais il est important de garder à l’esprit les conseils suivant de façon à faciliter la compréhension pour le lecteur :

Start with an overview

Commencez la page avec une vue d’ensemble afin d’introduire le sujet avant d’entrer dans les détails. Cette partie n’a pas forcément besoin d’un titre de chapitre.

Establish a hierarchy

Essayez d’imaginer ce que la plupart des utilisateurs peuvent chercher à réaliser et pourquoi ils peuvent avoir besoin de rechercher des informations dans le Manuel. Fournissez les solutions pour les tâches les plus communes en début de page. Celles qui sont moins usuelles peuvent être déplacées en bas de page.

Group information logically

Les éléments qui sont en relation devraient être présentés ensemble. Cela peut parfois nécessiter de discuter de fonctionnalités peu utilisées en même temps que celles qui sont d’emploi courant, mais c’est ainsi.

Focus on user tasks, not just UI components

Par exemple, une section "Créer des armures personnalisées" est préférable à "Utiliser la palette principale".

Headings

Headings are used to give a structure and hierarchy to the information on the page.

The first section heading you enter will always be a Heading 1. Please also don’t skip heading levels (for example, by adding a Heading 3 after a Heading 1).

Niveau de titre	Usage
Titre 1	Use for the start of every section.
Titre 2	Use for the start of every sub-section, and to introduce single-step instructions (i.e. where a list is not necessary).
Titre 3	Use sparingly if additional sub-sections are required.

Try to start your headings with a verb, e.g. "Adding time signatures", rather than "Time signatures".

Content

De façon générale, le Manuel de MuseScore contient deux principaux types d’informations : descriptions et instructions pratiques.

Descriptive material

This is used to explain different areas of the program. For example:

A Palette is a folder containing musical symbols which can be applied to the score. MuseScore's default palettes contain collections of related symbols, but you can customize palettes to display almost any kind of symbol, line or text.

Le contenu descriptif tend à être un peu plus long et « étoffé » que les instructions pratiques d’emploi mais nous vous demandons d’utiliser, chaque fois que possible, un langage clair et compréhensible.

Goal-oriented instructions

These explain how to perform a specific task. The instructions should be as short and direct as possible, generally taking the form of a numbered list. For example,

To create a new palette:

1. Open the Palettes tab

2. Cliquer sur Ajouter des palettes

3. Cliquer sur Créer une palette personnalisée

4. Donner un nom à votre nouvelle palette et cliquer sur Créer

Notice that we use bold text for named components of the user interface, including menus. Keyboard shortcuts, such as Ctrl+S, are rendered with GitBook's 'Keyboard' style.

Quand vous rédigez des instructions pratiques, veillez à :

• N’utiliser que des listes numérotés (pas de points)

• Commencer chaque instruction numérotée par un verbe

• N’écrire qu’une tâche / consigne par élément numéroté

Par exemple, au lieu d’écrire cela :

1. Open the Palettes tab and click Add palettes

Écrivez ceci :

1. Open the Palettes tab

2. Cliquer sur Ajouter des palettes

Pensez à inclure les raccourcis clavier dans les instructions pratiques, s’ils existent. C’est particulièrement important pour améliorer l'accessibilité du programme.

Use of non-written media

L’utilisation d’un média non écrit est encouragée en complément des descriptions écrites. Cela comprend :

• Des images GIF animées

• Des copies d’écran des parties pertinente de l’interface utilisateur

Creating animated GIFs

Les images GIF animées apportent de nombreux avantages par rapport aux copies d’écran et aux vidéos dans le sens où elles illustrent dans un minimum de temps les actions requises pour accomplir une tâche particulière. Il existe de nombreux outils disponibles pour créer des GIF ; nous recommandons toutefois le plan de travail suivant pour garantir une image claire et nette tout en minimisant le plus possible la taille du fichier (idéalement < 2 MB par GIF).

• Use only the MuseScore Studio 4 interface, and set its appearance to dark mode with blue highlights (to achieve consistency across the entire handbook)

• Planifiez et répétez à l’avance les clics de souris et les raccourcis clavier que vous utiliserez dans l’objectif de démontrer les étapes requises dans un temps aussi court que possible (idéalement < 10 sec.)

• Utilisez un outil libre tel que gifcap pour enregistrer le contenu de votre écran

• Utilisez un outil libre tel que KeyCastr pour enregistrer les touches de clavier (si nécessaire)

• Ne montrez que la partie de l’interface utilisateur nécessaire pour la démonstration de l’action