Guia de estilo
General
Case
Todo o texto deve ser escrito em caixa baixa. Isso inclui todos os parágrafos, títulos e títulos de página.
Nomes próprios e abreviações devem ser escritos com letra maiúscula de acordo com a forma predominante usada na página da Wikipédia sobre o tópico em questão.
Import the MusicXML file. ✅ MusicXML __is capitalized
Customize the user interface (UI). ✅ UI __is capitalized and __user interface __is not
Available in braille and Modified Stave Notation. ✅ MSN __is capitalized and __braille __is not
Contrações da linguagem cotidiana não devem ser escritas com caixa alta.
A quarter note (aka crotchet) is a musical duration. ✅ aka __is not capitalized
UI labels
Ao escrever instruções para o usuário, o texto que aparece na interface do usuário do MuseScore deve ser copiado na íntegra, incluindo qualquer caixa alta, e destacado em negrito, sem colocar aspas.
Press the Not now button. ✅ Not now __is bold and capitalized like in the application
Arrows in UI paths
Type -> to describe the path through submenus or through the hierarchy of a dialog.
GitBook will format -> as a single arrow character, though in editing mode it appears as separate characters. Since the text on either side will be styled in bold (as all text from the UI should be), keep the arrows bold too. Use a space on either side of each arrow.
Choose File -> Save other -> Save a copy... ✅
Uncheck Style -> Notes -> Shorten stems. ✅
Bullet points
Bullet points (aka unordered lists) are used for listed content that is not an ordered process.
If the contents of a group of bullet points are not complete sentences, there's no need to use periods.
Dynamics
Accidentals
Articulations ✅ No periods
When bullet points are complete sentences, use periods at the end of each sentence, even if there is only one.
This is a one-sentence bullet point, with a period at the end.
This is a bullet with two sentences. Periods are included after every sentence. ✅ Full sentences require periods
It's a common pattern to have some bolded text at the beginning of a bullet followed by a colon. In this case, the colon should be bolded too and the first character after the colon should be capitalized.
Bullet: This is a good example. ✅ The colon is bold and 'This' is capitalized
Bullet: this is a bad example. ❌ The colon is not bold and 'this' is not capitalized
Numbered lists
Numbered lists (aka ordered lists) are used for listed content that must be done in sequence. For explanations of how to execute a task, try to keep it to one sentence per number, and use periods at the end of each one.
Think of what to say.
Express each step a short sentence with a period at the end.
Finish the list. ✅
Hyperlinks
Quando apropriado, hiperlinks podem ser adicionados a palavras-chave ou frases em texto simples, que devem ser escritos de forma a fazer sentido sem o link. Em geral, o URL completo não deve ser exibido.
Watch the tutorial video. ✅ Text makes sense without the link
Veja o tutorial aqui. ❌ O texto não faria sentido se o link fosse removido
Veja em https://www.youtube.com/watch?v=z4Ecaaqwg8U. ❌ Não mostrar a URL
Plain domain names should be captalized like the brand name. The top-level domain (TLD, e.g. .com, .org, .co.uk, etc.) should be omitted unless there's a good reason to include it.
Find us on Facebook and YouTube. ✅ Omit .com TLDs for these popular sites
Listen on Audio.com. ✅ TLD is part of the website's branding
Visit MuseScore.org. ✅ TLD is necessary to distinguish from MuseScore.com
Download the installer from MuseHub.com. ✅ Referring specifically to the website
Get the sounds in MuseHub. ✅ Referring to the app (but linking to the website)
Keyboard shortcuts
Os atalhos de teclado devem ser formatados da seguinte maneira:
Press
Shift+1—9. ✅ en-dash __indicates rangePress
Ctrl+Shift++/-(Mac:Cmd+Shift++/-). ✅ slash __indicates alternatives
Os modificadores devem ser escritos nesta forma e nesta ordem para cada plataforma:
Windows/Linux:
Win+Ctrl+Alt+Shift+Fn+...✅Mac:
Ctrl+Cmd+Option+Shift+Fn+...✅
In Linux-specific instructions, the Win key should be written as Super.
Teclas que digitam caracteres imprimíveis devem ser representadas por esse caractere.
.,;'[]/\-=`etc. ✅
All non-printing keys should be referenced by their (possibly abbreviated) name rather than by a symbol. This includes the cursor keys.
SpaceBackspaceDelInsEscReturnUpDownLeftRightPgUpPgDnHomeEndMenuCaps Lock✅
Typed characters
Typed sequences should usually be formatted as inline code, even if it's just a single character.
To enter a double flat, type
bb. ✅ Inline code __(single element)
Occasionally, it may be preferable to show the actual keys pressed, formatted as keyboard shortcuts rather than as inline code.
To enter a double flat, type
BB. ✅ Keyboard keys __(space between each key)
Structure
Pages
Page titles
Os títulos das páginas devem ser relativamente curtos. O ideal é que o título ocupe uma linha no Resumo à esquerda da tela, embora isso nem sempre seja possível. Lembre-se de que os títulos das páginas podem ser significativamente maiores quando traduzidos para outros idiomas além do inglês.
Dicas para manter títulos de páginas curtos:
Evite dizer "partitura" (e.g. "Selecionando elementos", não "Selecionando elementos na partitura")
Evite dizer "MuseScore" (e.g. "Atualizando", não "Atualizando o MuseScore Studio")
Subpages
Ao usar subpáginas, apenas um nível de subpágina pode ser usado. Nunca crie uma sub-subpágina.
As páginas principais devem ter títulos bem curtos porque o título aparece nas URLs de todas as suas subpáginas.
Em geral, preferimos usar grupos em vez de subpáginas, para evitar aninhamento no Resumo.
Groups
Group names should be written in sentence case – the ALL CAPS styling is handled by GitBook automatically.
Os grupos devem ter nomes bem curtos. Isso ocorre porque o nome do grupo aparece nos URLs de todas as páginas dentro do grupo.
É possível editar o slug do grupo para torná-lo mais curto que o nome do grupo. No entanto, em geral, isso não deve ser feito. Em vez disso, o nome do grupo deve ser o mais curto possível.
Atualizado
Isto foi útil?