Editing the handbook

Guidelines for writing articles

Então, você gostaria de contribuir para o manual do MuseScore 4? Ótimo! Estamos muito felizes com sua presença.

Esta página contém breves orientações para você começar a escrever artigos. Leia-a atentamente antes de editar qualquer item do nosso manual. Estas informações têm o objetivo de ajudar, mas se tiver alguma dúvida ou pergunta, participe da discussão no fórum de Documentação.

Structure - General principles

Cada página deve explicar um único tópico de forma mais ou menos completa. Se uma página parecer muito longa, tente dividi-la em páginas separadas.

Nem todas as páginas são idênticas, mas manter o seguinte em mente pode ajudar você a estruturar o conteúdo da sua página de uma forma que seja fácil de entender para o leitor:

Start with an overview

Começar sua página com uma visão geral pode ajudar a introduzir um tópico antes de entrar em detalhes. Visões gerais geralmente não precisam de um título de seção.

Establish a hierarchy

Pense no que a maioria dos usuários buscará alcançar e por que eles podem estar recorrendo ao manual em busca de informações. Coloque as soluções para as tarefas mais comuns no topo da página; informações menos necessárias podem ser colocadas no final.

Group information logically

Conceitos relacionados devem ser discutidos em conjunto. Às vezes, isso pode exigir que recursos menos utilizados sejam discutidos juntamente com os mais utilizados, mas não há problema.

Focus on user tasks, not just UI components

Por exemplo, uma seção sobre "Criação de armaduras de clave personalizadas" é melhor do que uma seção chamada "Uso da paleta principal".

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

Nível de título	Usage
T´titulo 1	Use for the start of every section.
Título 2	Use for the start of every sub-section, and to introduce single-step instructions (i.e. where a list is not necessary).
Título 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

O manual do MuseScore contém basicamente dois tipos principais de informações: material descritivo e instruções 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.

O material descritivo tende a ser mais longo e mais "detalhado" do que as instruções orientadas a objetivos, mas ainda pedimos que você use uma linguagem simples e clara sempre que possível.

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. Clique em Adicionar paletas

3. Clique em Criar paleta personalizada

4. Nomeie sua nova paleta e clique em Criar

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.

Ao escrever instruções orientadas a objetivos, por favor:

• Use apenas listas numeradas (sem pontos)

• Comece cada instrução numerada com um verbo

• Escreva apenas uma tarefa/direção por item numerado

Por exemplo, em vez de escrever isto:

1. Open the Palettes tab and click Add palettes

Escreva isto:

1. Open the Palettes tab

2. Clique em Adicionar paletas

Certifique-se de incluir opções de teclado para instruções orientadas a objetivos, quando tais opções existirem. Isso é especialmente importante para melhorar a acessibilidade do programa.

Use of non-written media

O uso de meios não escritos é incentivado como complemento às descrições escritas. Isso inclui:

• GIFs animados

• Capturas de tela de partes relevantes da interface do usuário

Creating animated GIFs

GIFs animados oferecem muitas vantagens em relação a capturas de tela e vídeos, pois expõem no menor tempo possível a sequência de ações necessárias para realizar uma tarefa específica. Existem muitas ferramentas disponíveis para criar GIFs, mas recomendamos o seguinte fluxo de trabalho para garantir uma qualidade de imagem nítida e clara, mantendo o menor tamanho de arquivo possível (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)

• Planeje e ensaie os cliques do mouse e os atalhos do teclado que você usará, com o objetivo de demonstrar as etapas necessárias no menor tempo possível (idealmente <10s)

• Use uma ferramenta gratuita como o gifcap para gravar o conteúdo da sua tela

• Use uma ferramenta gratuita como o KeyCastr para gravar as teclas digitadas (quando necessário)

• Mostre apenas a quantidade de UI necessária para demonstrar uma tarefa específica