Edición del manual

Guidelines for writing articles

Así que le gustaría contribuir al manual de MuseScore 4, ¡genial! Estamos encantados de que estés aquí.

Esta página contiene breves indicaciones para comenzar a escribir artículos. Lea esta página cuidadosamente antes de editar cualquier cosa en nuestro manual. Esta información está destinada a ayudar, pero si tiene dudas sobre algo o tiene alguna pregunta, únase a la discusión en el Foro de documentación.

Structure - General principles

Cada página debe explicar un solo tema más o menos completamente. Si una página siente que se está haciendo demasiado extensa, intente dividirla en páginas separadas.

No todas las páginas son idénticas, pero tener lo siguiente en mente puede ayudarle a estructurar el contenido de su página de una manera fácil de entender para el lector:

Start with an overview

Comenzar su página con una descripción general puede ayudar a introducir un tema antes de lanzarse a los detalles. Las descripciones generales no necesitan un encabezado de sección.

Establish a hierarchy

Piense en lo que la mayoría de los usuarios intentarán lograr y por qué podrían estar llegando al manual para buscar información. Ponga soluciones para las tareas más comunes hacia la parte superior de la página; la información menos comúnmente necesaria puede ir más abajo.

Group information logically

Los conceptos relacionados deben tratarse juntos. Esto a veces puede requerir que características menos comunes sean tratadas junto con las de más usadas, pero eso está bien.

Focus on user tasks, not just UI components

Por ejemplo, una sección sobre "Crear armaduras personalizadas" es mejor que una sección llamada "Uso de la paleta maestra".

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).

Nivel de encabezado	Usage
Encabezado 1	Use for the start of every section.
Encabezado 2	Use for the start of every sub-section, and to introduce single-step instructions (i.e. where a list is not necessary).
Encabezado 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

El manual de MuseScore en general contiene dos tipos principales de información: material descriptivo e instrucciones orientadas a objetivos.

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.

El material descriptivo tiende a ser más extenso y más "desarrollado" que las instrucciones orientadas a objetivos, pero aún así le pedimos que use un lenguaje simple y claro siempre que sea posible.

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. Haga clic en Agregar paletas

3. Haga clic en Crear paleta personalizada

4. Escriba el nombre de su nueva paleta y haga clic en Crear

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.

Al escribir instrucciones orientadas a objetivos, por favor:

• Use solo listas numeradas (no de viñetas sin numeración)

• Comience cada instrucción numerada con un verbo

• Escriba solo una tarea/instrucción por elemento numerado

Por ejemplo, en lugar de escribir esto:

1. Open the Palettes tab and click Add palettes

Por favor escriba esto:

1. Open the Palettes tab

2. Haga clic en Agregar paletas

Asegúrese de incluir opciones de teclado para instrucciones orientadas a objetivos, donde existan tales opciones. Esto es especialmente importante para mejorar la accesibilidad del programa.

Use of non-written media

Se recomienda el uso de medios no escritos como complemento a las descripciones escritas. Esto incluye:

• GIFs animados

• Capturas de pantalla de partes relevantes de la interfaz de usuario

Creating animated GIFs

Los GIFs animados ofrecen muchas ventajas sobre las capturas de pantalla y videos, ya que exponen en la menor cantidad de tiempo la secuencia de acciones requeridas para lograr una tarea en particular. Hay muchas herramientas disponibles para crear GIFs, sin embargo, recomendamos el siguiente flujo de trabajo para garantizar una calidad de imagen nítida y clara mientras se mantiene lo más pequeño posible tamaño del archivo (idealmente <2MB por 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)

• Planifique y ensaye los clics del ratón y los atajos de teclado que utilizará, con el objetivo de demostrar los pasos requeridos en el tiempo más corto posible (idealmente <10s)

• Use una herramienta gratuita como gifcap para grabar el contenido de su pantalla

• Use una herramienta gratuita como KeyCastr para grabar pulsaciones de teclas (cuando sea necesario)

• Solo muestre la parte de la interfaz de usuario necesaria para mostrar una tarea concreta