Microsoft Learnin tyylin ja sävyn pikaopas

Tämä pikaopas teknisen sisällön kirjoittamiseen Microsoft Learnissa julkaistavaksi. Nämä ohjeet koskevat sekä kirjoitettaessa uusia artikkeleita että päivitettäessä olemassa olevia.

Parhaat käytännöt:

• Tarkista artikkelin kieliasu, esimerkiksi kopioimalla ja liittämällä teksti Microsoft Wordiin.
• Käytä vapaata ja helppoa kieltä – kuten puhuessasi kahden kesken toisen henkilön kanssa.
• Käytä yksinkertaisia lauseita. Helposti luettavien lauseiden ansiosta lukija voi nopeasti soveltaa jakamiasi ohjeita.

Noudata Microsoft-sävyn periaatteita

Yritämme parhaamme mukaan noudattaa näitä periaatteita kirjoittaessamme teknistä Microsoft Learn -sisältöä. Emme ehkä aina onnistu täydellisesti, mutta voimme ainakin yrittää!

• Keskity tarkoitukseen: Asiakkailla on tietty tarkoitus mielessään lukiessaan tarjoamiamme ohjeita. Ennen kuin aloitat artikkelin kirjoittamisen, määritä mielessäsi kohdeasiakas ja mitä hän on tekemässä. Kirjoita sitten artikkeli, joka auttaa tätä kuviteltua asiakasta hänen tietyssä tehtävässään.
• Kirjoita yleiskieltä: Käytä luonnollisia sanoja; samoja, jotka asiakkaasi käyttävät. Sinun ei tarvitse olla muodollinen, mutta muista tekninen oikeellisuus. Anna esimerkkejä, joissa selität uusia käsitteitä.
• Kirjoita lyhyesti: Karsi tekstistä kaikki turha. Kirjoita myönteiseen sävyyn, mutta ilman turhia sanoja ja tarkenteita. Pidä lauseet lyhyinä ja ytimekkäinä. Keskity artikkelissa olennaiseen. Jos tehtävässä on tarkenne, aloita virke tai kappale sillä. Minimoi myös huomautusten määrä. Käytä näyttökuvaa, jos voit säästää sillä sanoja.
• Asettele teksti selkeästi: Aloita aina tärkeimmistä asioista. Jaa pitkiä toimintosarjoja helpommin hallittaviksi ryhmiksi käyttämällä tekstiosioita. (Yli 12 vaihetta on todennäköisesti liikaa.) Käytä näyttökuvaa, jos se selkeyttää asiaa.
• Muista myötätunto: Käytä tekstissä tukevaa sävyä ja vältä vastuun sälyttämistä asiakkaalle. Korosta suoraan kohtia, jotka voivat aiheuttaa turhautumista. Varmista, että artikkeli keskittyy asiakkaille olennaiseen sisältöön; älä kirjoita teknistä luentoa.

Pidä mielessä lokalisointi ja konekäännös

Tekniset artikkelimme käännetään useille kielille, ja joitakin tekstejä on muokattava eri markkinoille tai alueille. Käyttäjät voivat myös lukea teknisten artikkeleidemme konekäännöksiä verkossa. Pidä siis seuraavat ohjeet mielessä kirjoittaessasi:

• Varmista, että artikkelissa ei ole kielioppi- tai oikeinkirjoitusvirheitä: Tämä pitäisi yleensäkin tehdä tekstistä riippumatta. Joissakin Markdown-editoreissa (kuten MarkdownPad 2.0) on perusoikolukutoimintoja, mutta kannattaa liittää artikkelin valmis HTML-sisältö suoraan Wordiin, jossa on tehokkaampi oikeinkirjoituksen ja kieliopin tarkistus.
• Muista mahdollisimman lyhyet lauseet: Pitkät ja monimutkaiset lauseet ja virkkeet vaikeuttavat tekstin kääntämistä. Jaa mahdollisuuksien mukaan pitkiä virkkeitä, ellei se vaikuta olennaisesti tekstin sävyyn. Emme myöskään halua luonnottomalta kuulostavia artikkeleita.
• Käytä yksinkertaisia ja johdonmukaisia lauserakenteita: Johdonmukaisuus parantaa myös käännöksiä. Vältä sulkulausekkeita ja sivuhuomautuksia ja muista esittää teema eli tekstiyhteydessä tuttu aihe ensin. Tutustu muutamaan jo julkaistuun artikkeliin. Jos löydät helppolukuisen ja tyyliltään selkeän artikkelin, voit käyttää sitä mallina.
• Käytä johdonmukaisia sanoja ja muotoja: Johdonmukaisuus on selkeän tekstin avainkäsite. Älä kirjoita sanaa isolla alkukirjaimella, ellei se ole virkkeen alussa tai erisnimi.
• Muista englannin ”pienet sanat”: Kun kirjoitat englanniksi, jotkin pienet sanat (kuten ”a”, ”the”, ”that” ja ”is”) voivat tuntua jopa turhilta, mutta ne ovat elintärkeitä hyvän konekäännöksen varmistamisessa. Muista sisällyttää ne.

Muita tyylin ja sävyn ongelmakohtia

• Älä pilko vaiheita kommenteilla tai sivuhuomautuksilla.
• Koodikatkelmia sisältävissä vaiheissa voit laittaa lisätietoja vaiheesta suoraan koodiin kommentteina. Tämä vähentää tekstin määrää, jota käyttäjien on luettava. Tärkeimmät tiedot kopioituvat koodiprojektiin, jossa ne muistuttavat käyttäjiä myöhemmin siitä, mitä koodi tekee.
• Aloita otsikot isolla alkukirjaimella.
• Kirjoita ”sisäänkirjautuminen”; ei ”sisäänkirjaus”.
• Lisää ohjeita on kohdassa Microsoft Writing Style Guide.

Lokalisoidut ohjeet

• Jos annat lokalisoituja ohjeita, tutustu globalisointiviittauksiin.
• Lokalisointiohjeet, eri kielten tyyli ja käyttö teknisissä julkaisuissa sekä eri markkina-alueiden tietomuodot löytyvät kunkin kielen tyylioppaasta.
• Microsoftin terminologiassa voit hakea tuotekohtaisia hyväksyttyjä termejä tai ladata kielelläsi Microsoftin terminologiakokoelman.
• Lisätietoja lokalisoinnista on Microsoft Writing Style Guide -oppaan kohdassa "Global communications".

Muistiinpano

Useimmat lokalisoidut ohjeet eivät tarjoa mahdollisuutta muokata tai antaa palautetta GitHubin kautta. Jos haluat antaa palautetta lokalisoidusta sisällöstä, käytä https://aka.ms/provide-feedback lomaketta.