Überprüfen der Dokumentation mit GitHub-Issues

Abgeschlossen

Eine der nützlichsten Möglichkeiten, zu Microsoft Learn beizutragen, ist, direktes Feedback zu einem Dokumentationsartikel zu geben. Über den Feedback-Link auf der Seite können Sie uns Änderungen, Vorschläge, Fragen oder andere Erkenntnisse mitteilen, die Sie beim Stöbern entdecken. Da die meisten Inhalte der Microsoft Learn-Dokumentation in GitHub-Repositorys gespeichert sind, können Sie Ihr Feedback über einen GitHub-Prozess, das sogenannte Übermitteln eines GitHub-Issues, abgeben.

Ein Issue in GitHub ist ein Tool, mit dem Technologieanwender*innen, Ingenieur*innen und andere Besucher*innen von Microsoft Learn Feedback zu einem bestimmten Artikel teilen und nachverfolgen können. Sie füllen ein Formular aus, um Ihr Feedback zu dokumentieren und posten es im Repository des Quellartikels auf GitHub, wo ein*e Autor*in oder Eigentümer*in benachrichtigt wird. Jeder, der das GitHub-Repository besucht, kann Issues sehen. Sie dienen dazu, wertvolles Feedback zu sammeln und zu speichern, wie z. B. das Melden von Fehlern, Funktionsanforderungen oder Notizen.

Warum sollten Sie Inhalte auf GitHub überprüfen?

Die Bereitstellung von Inhaltsbewertungen auf GitHub ist ein direkter Weg, um zu einem Thema beizutragen, für das Sie sich begeistern oder in dem Sie sich auskennen. Das bedeutet, dass Sie Ihre Ideen hinzufügen können, während Sie sich mit einem Thema in der Microsoft-Dokumentation beschäftigen. Wenn Sie Ihre Erkenntnisse zum Wissenspool beitragen, können Sie die Microsoft-Produkterfahrungen für Millionen anderer Benutzer*innen verbessern. Ihr Feedback entwickelt Inhalte für andere Microsoft Learn-Benutzer*innen, die auf Microsoft-Produkte und ihre unterstützenden Inhalte angewiesen sind.

In den meisten Fällen können Sie mit dem Übermitteln von GitHub-Feedback Ihre Ideen an das Team senden, das für den Inhaltssatz des Produkts zuständig ist. Dieser Weg der Zusammenarbeit zwischen Content-Teams und Produktnutzer*innen ermöglicht den Austausch und die Diskussion von Feedback direkt in GitHub.

Der Beitrag zu Dokumentationsinhalten kann auch für Sie berufliche Vorteile mit sich bringen. GitHub ist eine bekannte Plattform, auf der technische Beiträge erstellt und nachverfolgt werden können. Jedes Mal, wenn Sie auf GitHub zu einem Projekt beitragen, wird dies in Ihrem GitHub-Profil angezeigt. Mit der Zeit können Sie eine Liste mit Ihren Beiträgen erstellen, die Sie Ihrem technischen Portfolio hinzufügen können.

So geben Sie Feedback zum Inhalt

Erinnern Sie sich daran, dass viele Dokumentationsartikel zu Microsoft Learn in GitHub-Repositorys gespeichert sind. In vielen GitHub-Repositorys sind GitHub-Issues aktiviert. Wenn diese Funktion aktiviert ist, finden Sie am Ende eines Artikels auf learn.microsoft.com die Option, Feedback zu dieser Seite zu übermitteln.

Screenshot of the feedback options at the bottom of a documentation article.

Um ein Issue zu erstellen und zu übermitteln, benötigen Sie ein GitHub-Konto. Hier erfahren Sie, wie Sie aus einem Microsoft Learn-Artikel ein Issue in GitHub übermitteln:

  1. Melden Sie sich bei Ihrem GitHub-Konto an.

  2. Navigieren Sie zum Microsoft Learn-Dokumentationsartikel, zu dem Sie Feedback geben möchten.

  3. Suchen Sie unter dem Artikel die Überschrift Feedback. Hier finden Sie ein Feld mit der Bezeichnung Diese Seite.

    • Um Feedback zu dem Artikel zu geben, wählen Sie Diese Seite aus. Dadurch gelangen Sie zu einem leeren Issue-Formular auf GitHub, in das Sie Ihre Kommentare einfügen können. Wählen Sie jetzt diese Option.
    • Wenn Sie sich andere GitHub-Issues ansehen möchten, die für dieses Thema übermittelt wurden, wählen Sie Feedback für diese Seite anzeigen aus. Jeder kann andere GitHub-Issues in einem öffentlichen Repository lesen. Wenn Sie ein GitHub-Konto haben, können Sie die Probleme außerdem kommentieren.
    • Wenn Sie Dieses Produkt auswählen, können Sie Feedback zum Produkt geben. Diese Option wird derzeit nicht ausführlich behandelt, damit wir uns darauf konzentrieren können, Feedback zur Dokumentation zu geben.
  4. Nachdem Sie Diese Seite ausgewählt haben, werden Sie aufgefordert, sich bei Ihrem GitHub-Konto anzumelden, sofern Sie noch nicht angemeldet sind. Anschließend wird in GitHub ein leeres Feedbackformular für Issues angezeigt.

  5. Geben Sie einen Titel für Ihr Feedback ein, der Ihre Eingabe kurz zusammenfasst.

  6. Beschreiben Sie im folgenden Textfeld Ihr Feedback und geben Sie erforderlichen Kontext an. Verwenden Sie die Symbolleiste, um Ihre Beschreibung zu formatieren, z. B. das Hinzufügen von Anführungszeichen, einer Liste oder Erwähnung.

  7. Wählen Sie abschließend Neues Issue übermitteln aus.

Screenshot of a blank GitHub issues form to submit feedback on a documentation article.

Nachverfolgen von Issues

Autor*innen oder andere Inhaltsbesitzer*innen des Artikels werden benachrichtigt, wenn Sie Ihr Issue übermitteln. Sie können Kommentare zu dem Issue über Ihre GitHub-Benachrichtigungen oder im Repository in der Registerkarte Issues nachverfolgen.

Sie können in der Registerkarte Issues auch andere Issues, die für dieses Repository übermittelt wurden, ansehen, überprüfen und kommentieren.

Screenshot of the GitHub issues tab in a GitHub repo.