Microsoft Learn-stil og -stemme hurtig start

Denne hurtige start er en kort vejledning i, hvordan du skriver teknisk indhold til offentliggørelse på Microsoft Learn. Disse retningslinjer gælder, uanset om du opretter ny dokumentation eller opdaterer eksisterende dokumentation.

Bedste praksis:

• Køre stavekontrol og rette grammatiske fejl i dine artikler, også selvom du måske skal indsætte teksten i Microsoft Word for at gøre det.
• Bruge en afslappet og venlig tone – ligesom når du taler med en anden person.
• Bruge enkle sætninger. Læsevenlige sætninger betyder, at læseren hurtigt kan bruge den vejledning, du deler.

Følge Microsoft principper for valg af tone.

Vi stræber efter at følge disse principper, når vi skriver teknisk indhold til Microsoft Learn. Det er ikke altid, vi rammer plet, men vi forsøger!

• Fokuser på indholdet: Kunderne har noget helt specifikt i tankerne, når du kigger i din dokumentation. Før du begynder at skrive, skal du fastslå, hvem kunden er, og hvilken opgave han eller hun forsøger at løse. Skriv derefter din artikel, så den hjælper kunden med at løse lige præcis den opgave.
• Brug almindelige ord: Prøv at bruge dit naturlige sprog, som er de samme ord, dine kunder bruger. Vær mindre formel, men ikke mindre teknisk. Giv eksempler, der forklarer nye koncepter.
• Skriv kortfattet: Fyld ikke på med unødvendige ord. Vær positiv, og undlad at bruge ekstra ord eller mange forudsætninger. Hold sætninger korte og præcise. Hold fokus på artiklens emne. Hvis der er forudsætninger til at løse en opgave, skal du angive disse i starten af sætningen eller afsnittet. Begræns desuden antallet af noter. Brug et skærmbillede, når det kan stå i stedet for ord.
• Gør det nemt at skimme artiklen: Skriv de vigtigste ting først. Brug afsnit for at opdele lange procedurer i mindre grupper af trin. Procedurer med mere end 12 trin er sandsynligvis for lange. Brug et skærmbillede, når det tilføjer klarhed.
• Vis indlevelse: Brug et opmuntrende ordvalg i artiklen, og begræns mængden af ansvarsfraskrivelser. Fremhæv gerne de områder, der kan gøre kunderne frustrerede. Sørg for, at artiklen har fokus på det, der er vigtigt for kunderne. Du skal ikke bare komme med en teknisk forelæsning.

Overvej lokalisering eller maskinoversættelse

Vores tekniske artikler oversættes til flere sprog, og nogle bliver tilpasset bestemte markeder eller geografiske områder. Brugerne kan også bruge maskinoversættelse på internettet, når de læser tekniske artikler. Så vær opmærksom på følgende retningslinjer, når du skriver:

• Sørg for, at artiklen ikke indeholder grammatiske fejl, stavefejl eller forkert brug af punkttegn: Det gælder altid, når du skriver. Nogle Markdown-redigeringsprogrammer (for eksempel MarkdownPad 2.0) indeholder en grundlæggende stavekontrol, men det er god praksis at indsætte det gengivne HTML-indhold fra artiklen i Word, som har en bedre funktion til kontrol for stavefejl og grammatiske fejl.
• Gør dine sætninger så korte som muligt: Sammensatte sætninger eller mange ledsætninger gør det sværere at oversætte teksten. Opdel sætninger, når det er muligt, uden at du gentager dig selv, eller det lyder mærkeligt. Vi ønsker heller ikke, at artikler skrives i et unaturlig sprog.
• Brug simple og ensartede sætningsopbygninger: Ensartethed er bedre til oversættelse. Undgå mange parenteser og indskudte sætninger, og skriv grundleddet så tidligt i sætningen som muligt. Se nogle af de allerede udgivne artikler. Hvis en artikel er skrevet i et læsevenligt sprog, kan du bruge den som model.
• Brug de samme udtryk: Det er vigtigt, at teksten er konsistent. Undgå at skrive ord med stort, hvis det ikke starter en sætning eller er et navneord.
• Medtag "små ord": Det er vigtigt, at ord som "en", "et", "den", "det" og lignende bruges rigtigt, da det vil forbedre kvaliteten af maskinoversættelse. Så husk at medtage dem.

Andre problemer med skrivestil og tone, som du skal være opmærksom på

• Undgå at bryde trinvise procedurer op med kommentarer eller sidebemærkninger.
• Hvis trin indeholder kodestykker, kan du placere ekstra oplysninger om trinnet i koden som kommentarer. Dette reducerer mængden af tekst, som brugerne skal gennemlæse. De vigtigste oplysninger kopieres til kodeprojektet for at minde brugerne om, hvad koden gør når de henviser til den senere.
• Brug små og store bogstaver korrekt i titler og overskrifter.
• Sørg for at være ens i brugen af udtryk som "log ind" eller "log på".
• Se Microsoft Writing Style Guide for at få flere retningslinjer.

Lokaliseret dokumentation

• Hvis du bidrager til lokaliseret dokumentation, kan du se globaliseringsreferencerne.
• For retningslinjer til lokalisering, oplysninger om sproglig stil og sprogbrug i tekniske publikationer og for oplysninger om markedsspecifikke dataformater, kan du hente vores vejledning til grammatik og sproglig stil på dit sprog.
• Besøg Microsoft Terminology for at søge efter produktspecifik godkendt terminologi eller for at downloade Microsoft Terminology Collection på dit sprog.
• Hvis du vil vide mere om lokalisering, kan du se "Global communications" i Microsoft Writing Style Guide.

Bemærk

Den mest lokaliserede dokumentation giver ikke mulighed for at redigere eller give feedback via GitHub. Hvis du vil give feedback om lokaliseret indhold, skal du bruge https://aka.ms/provide-feedback formularen.