Käsikirjan muokkaus

Guidelines for writing articles

Haluaisit siis osallistua MuseScore 4 -käsikirjan kehittämiseen – hienoa! Olemme iloisia, että olet täällä.

Tämä sivu sisältää lyhyet ohjeet artikkelien kirjoittamisen aloittamiseen. Lue tämä sivu huolellisesti ennen kuin muokkaat mitään käsikirjassamme. Näiden tietojen tarkoituksena on auttaa, mutta jos olet epävarma jostakin tai sinulla on kysyttävää, liity keskusteluun dokumentaatiofoorumilla.

Structure - General principles

Jokaisen sivun tulisi selittää yksi aihe enemmän tai vähemmän kattavasti. Jos sivu tuntuu liian pitkältä, kokeile jakaa se erillisille sivuille.

Kaikki sivut eivät ole identtisiä, mutta seuraavien seikkojen pitäminen mielessä voi auttaa sinua jäsentämään sivusi sisällön lukijan helposti ymmärrettävällä tavalla:

Start with an overview

Sivun aloittaminen yleiskatsauksella voi auttaa esittelemään aiheen ennen yksityiskohtiin siirtymistä. Yleiskatsaukset eivät yleensä tarvitse osioiden otsikkoa.

Establish a hierarchy

Mieti, mitä useimmat käyttäjät yrittävät saavuttaa ja miksi he saattavat tulla käsikirjaan etsimään tietoa. Sijoita yleisimpien tehtävien ratkaisut sivun yläosaan; harvemmin tarvittavat tiedot voivat olla alaosassa.

Group information logically

Toisiinsa liittyviä käsitteitä tulisi käsitellä yhdessä. Tämä voi joskus edellyttää, että harvemmin käytettyjä ominaisuuksia käsitellään yleisemmin käytettyjen rinnalla, mutta se on ihan ok.

Focus on user tasks, not just UI components

Esimerkiksi osio "Mukautettujen sävellajimerkintöjen luominen" on parempi kuin osio "Pääpaletin käyttö".

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

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

MuseScore-käsikirja sisältää karkeasti ottaen kahdenlaisia ​​tietoja: kuvailevaa materiaalia ja tavoitteellisia ohjeita.

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.

Kuvaileva materiaali on yleensä pidempää ja "täyteläisempää" kuin tavoitteelliset ohjeet, mutta pyydämme silti käyttämään yksinkertaista ja selkeää kieltä aina kun mahdollista.

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. Klikkaa Lisää paletteja

3. Valitse Luo mukautettu paletti

4. Nimeä uusi paletti ja klikkaa Luo

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.

Kun kirjoitat tavoitteellisia ohjeita, huomioithan seuraavat asiat:

• Käytä vain numeroituja luetteloita (ei luettelomerkkejä)

• Aloita jokainen numeroitu käsky verbillä

• Kirjoita vain yksi tehtävä/ohje numeroitua kohtaa kohden

Esimerkiksi tämän kirjoittamisen sijaan:

1. Open the Palettes tab and click Add palettes

Kirjoita tämä:

1. Open the Palettes tab

2. Klikkaa Lisää paletteja

Muista sisällyttää näppäimistöasetukset tavoitteellisia ohjeita varten, jos sellaisia ​​on. Tämä on erityisen tärkeää ohjelman esteettömyyden parantamiseksi.

Use of non-written media

Kirjallisten kuvausten täydennyksenä kannustetaan käyttämään muita kuin kirjoitettuja medioita. Tähän sisältyvät:

• Animoidut GIF-kuvat

• Kuvakaappauksia käyttöliittymän olennaisista osista

Creating animated GIFs

Animoiduilla GIF-tiedostoilla on monia etuja kuvakaappauksiin ja videoihin verrattuna, koska ne näyttävät lyhyessä ajassa tietyn tehtävän suorittamiseen tarvittavat toimenpiteet. GIF-tiedostojen luomiseen on saatavilla monia työkaluja, mutta suosittelemme seuraavaa työnkulkua terävän ja selkeän kuvanlaadun varmistamiseksi ja mahdollisimman pienen tiedostokoon säilyttämiseksi (mieluiten &x3C;2 Mt GIF-tiedostoa kohden).

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

• Suunnittele ja harjoittele käyttämiäsi hiiren napsautuksia ja pikanäppäimiä pyrkien havainnollistamaan tarvittavat vaiheet mahdollisimman lyhyessä ajassa (mieluiten <10s).

• Käytä ilmaista työkalua, kuten gifcapia, tallentaaksesi näytön sisällön

• Käytä ilmaista työkalua, kuten KeyCastria, näppäinpainallusten tallentamiseen (tarvittaessa)

• Näytä vain tarvittava käyttöliittymän määrä tietyn tehtävän havainnollistamiseksi