Schnellstart zum Stil und zur Sprache in Microsoft Learn

  • Artikel

Bei diesem Schnellstart handelt es sich um einen kompakten Leitfaden zum Schreiben von technischen Inhalten für die Veröffentlichung auf Microsoft Learn. Dieser Leitfaden gilt, wenn Sie eine neue Dokumentation erstellen oder eine vorhandene Dokumentation aktualisieren.

Bewährte Methoden:

  • Prüfen Sie die Rechtschreibung und Grammatik in Ihren Artikeln, auch wenn das bedeutet, dass Sie die Inhalte zuvor kopieren und zur Prüfung in eine Microsoft Word-Datei einfügen müssen.
  • Schlagen Sie einen freundlichen Tonfall an, so als würden Sie sich mit jemandem unterhalten.
  • Schreiben Sie einfache Sätze. Leicht verständliche Sätze ermöglichen es dem Leser, den von Ihnen freigegebenen Leitfaden schnell nachzuvollziehen und zu nutzen.

Verwenden der Microsoft-Prinzipien zur Sprache

Versuchen Sie immer, sich an diese Prinzipien zu halten, wenn Sie technische Inhalte für Microsoft Learn verfassen. Das ist vielleicht nicht immer möglich, aber Sie sollten es jederzeit versuchen!

  • Konzentrieren Sie sich auf das Ziel: Kunden haben einen bestimmten Zweck im Sinn, wenn sie unsere Dokumentation lesen. Bevor Sie mit dem Schreiben beginnen, legen Sie genau fest, wer der Kunde ist und welche Aufgabe er erledigen möchte. Schreiben Sie Ihren Artikel dann so, dass Sie diesem bestimmten Kunden dabei helfen, diese bestimmte Aufgabe auszuführen.
  • Verwenden Sie alltägliche Begriffe: Versuchen Sie, in der Sprache Ihrer Kunden zu schreiben. Verwenden Sie eine informelle Sprache, aber verzichten Sie dabei nicht auf Fachbegriffe. Geben Sie Beispiele, um neue Konzepte zu erklären.
  • Achten Sie auf Knappheit: Verzichten Sie auf überflüssige Wörter. Seien Sie positiv, und verwenden Sie nicht übermäßig viele Füllwörter. Schreiben Sie kurze, knappe Sätze. Behalten Sie den roten Faden Ihres Artikels im Auge. Wenn eine Aufgabe ein Qualifizierungsmerkmal hat, setzen Sie dieses an den Anfang des Satzes oder Absatzes. Begrenzen Sie Fußnoten auf ein Minimum. Verwenden Sie einen Screenshot, wenn Sie sich damit ausschweifende Erläuterungen sparen können.
  • Vereinfachen Sie das Überfliegen Ihres Artikels: Erläutern Sie die wichtigsten Sachverhalte zuerst. Verwenden Sie Abschnitte, um komplexe Vorgänge in kleinere, leichter nachvollziehbare Gruppen von Schritten zu unterteilen. (Prozeduren, die aus mehr als zwölf Schritten bestehen, sind möglicherweise zu komplex.) Binden Sie einen Screenshot ein, wenn Sie damit Klarheit schaffen können.
  • Seien Sie einfühlsam: Vermitteln Sie Hilfsbereitschaft, und beschränken Sie Gewährleistungshinweise auf ein Minimum. Streichen Sie Abschnitte, die Kunden entmutigen könnten. Konzentrieren Sie sich darauf, was dem Kunden wichtig ist. Halten Sie keine technische Vorlesung.

Einbeziehen von Lokalisierung und Maschinenübersetzung

Unsere technischen Artikel werden in mehrere Sprachen übersetzt, und einige werden für bestimmte Märkte oder Geografien angepasst. Benutzer verwenden möglicherweise auch maschinelle Übersetzungen im Internet, um die technischen Artikel zu lesen. Behalten Sie also beim Schreiben die folgenden Richtlinien im Hinterkopf:

  • Stellen Sie sicher, dass Ihr Artikel keine Grammatik-, Rechtschreib- oder Zeichensetzungsfehler enthält: Dies ist eine grundlegende Anforderung. Einige Markdown-Editoren (wie Markdown Pad 2.0) bieten eine einfache Rechtschreibprüfung. Es empfiehlt sich jedoch, die HTML-Ausgabe des Inhalts in Word zu kopieren, das über eine umfangreichere Rechtschreib- und Grammatikprüfung verfügt.
  • Stellen Sie sicher, dass Ihre Sätze so kurz wie möglich sind: Übermäßig komplexe oder verschachtelte Sätze erschweren die Übersetzung. Teilen Sie Sätze auf, wenn dies möglich ist, ohne sich zu wiederholen oder komisch zu klingen. Artikel sollten nicht in unnatürlicher Sprache geschrieben werden.
  • Verwenden Sie eine einfache und konsistente Satzkonstruktion: Konsistenz ist besser für die Übersetzung. Vermeiden Sie Einschübe und Nebenbemerkungen, und stellen Sie das Subjekt so weit wie möglich an den Anfang des Satzes. Sehen Sie sich einige veröffentlichte Artikel an. Wenn Sie einen Artikel finden, der in einem leicht lesbaren Stil geschrieben ist, verwenden Sie ihn als Vorlage.
  • Verwenden Sie konsistente Formulierungen und Schreibweisen: Auch hier ist Konsistenz das A und O. Befolgen Sie die Rechtschreibregeln gemäß Duden (empfohlene Schreibweise).
  • Lassen Sie keine „unbedeutenden“ Wörter aus: Manche Wörter werden als unbedeutend angesehen, weil sie im Kontext verstanden werden (z.B. Artikel). Diese sind für die Maschinenübersetzung jedoch wichtig. Schließen Sie sie unbedingt mit ein.

Weitere zu beachtende Stil- und Sprachfragen

  • Unterbrechen Sie Schritte nicht mit Kommentaren oder Nebenbemerkungen.
  • Fügen Sie bei Schritten mit Codeausschnitten Informationen zum Schritt als Kommentar in den Code ein. Dadurch muss der Benutzer weniger Text lesen. Die wichtigsten Informationen werden in das Codeprojekt kopiert, damit Benutzer auch später noch wissen, wozu der Code dient.
  • Befolgen Sie die Rechtschreibregeln gemäß Duden (empfohlene Schreibweise).
  • Verwenden Sie die etablierte Microsoft-Terminologie.
  • Weitere Richtlinien finden Sie im Microsoft-Leitfaden zum Schreibstil.

Lokalisierte Dokumentation

  • Wenn Sie zu lokalisierten Dokumentationen beitragen, verweisen Sie auf die Hinweise zur Globalisierung.
  • Um Lokalisierungsrichtlinien, Informationen zum Sprachstil und zur Sprachverwendung in technischen Publikationen sowie Informationen zu marktspezifischen Datumsformaten zu erhalten, laden Sie den Styleguide in Ihrer Sprache herunter.
  • Navigieren Sie zur Microsoft-Terminologie, um nach produktspezifischer genehmigter Terminologie zu suchen oder die Microsoft-Terminologiesammlung in Ihrer Sprache herunterzuladen.
  • Weitere Informationen zur Lokalisierung finden Sie im Abschnitt „Globale Kommunikation“ im Microsoft-Leitfaden zum Schreibstil.

Hinweis

Bei den meisten lokalisierten Dokumentationen ist es nicht möglich, diese über GitHub zu bearbeiten oder Feedback über GitHub abzugeben. Wenn Sie Feedback zu lokalisierten Inhalten geben möchten, verwenden Sie das https://aka.ms/provide-feedback-Formular.