Leitfaden für Mitwirkende an der Microsoft-Dokumentation: ÜbersichtMicrosoft Docs contributor guide overview

Willkommen beim Leitfaden für Mitwirkende an unserer Dokumentation auf docs.microsoft.com.Welcome to the docs.microsoft.com (Docs) Contributor Guide!

Einige der Dokumentationssammlungen von Microsoft sind Open-Source und werden auf GitHub gehostet.Several of the Microsoft documentation sets are open source and hosted on GitHub. Nicht alle Dokumentationssammlungen sind vollständig frei verfügbar. Für viele gibt es aber öffentliche Repositorys, in denen Sie über Pull Requests vorgeschlagene Änderungen vornehmen können.Not all document sets are completely open source but many have public-facing repos where you can make suggested changes via pull requests. Dieser Open-Source-Ansatz optimiert und verbessert die Kommunikation zwischen Produkttechnikern, Inhaltsteams und Kunden. Außerdem bietet er weitere Vorteile:This open source approach streamlines and improves communication between product engineers, content teams, and customers, and has other advantages:

  • Durch die öffentliche Planung in Open-Source-Repositorys erhalten wir Feedback zu benötigten Dokumentationen.Open source repos plan in the open to get feedback on what docs are most needed.
  • Durch die öffentliche Prüfung in Open-Source-Repositorys können wir mit dem ersten Release den bestmöglichen Inhalt veröffentlichen.Open source repos review in the open to publish the most helpful content on our first release.
  • Durch öffentliche Updates in Open-Source-Repositorys können wir Inhalt kontinuierlich verbessern.Open source repos update in the open to make it easier to continuously improve the content.

Die Benutzeroberfläche auf docs.microsoft.com bezieht GitHub-Workflows direkt ein, um den Prozess noch einfacher zu gestalten.The user experience on docs.microsoft.com integrates GitHub workflows directly to make it even easier. Beginnen Sie mit dem Bearbeiten des angezeigten Dokuments.Start by editing the document you are viewing. Alternativ können Sie neue Artikel prüfen oder nützliche Tickets erstellen.Or, help by reviewing new topics, or create quality issues.

Important

Für alle Repositorys, die Veröffentlichungen auf docs.microsoft.com durchführen, gilt der Verhaltenskodex von Microsoft Open-Source oder von .NET Foundation (beide in englischer Sprache).All repositories that publish to docs.microsoft.com have adopted the Microsoft Open Source Code of Conduct or the .NET Foundation Code of Conduct. Weitere Informationen finden Sie in den häufig gestellten Fragen zum Verhaltenskodex.For more information, see the Code of Conduct FAQ. Wenden Sie sich mit Ihren Fragen oder Kommentaren alternativ an opencode@microsoft.com oder conduct@dotnetfoundation.org.Or contact opencode@microsoft.com, or conduct@dotnetfoundation.org with any questions or comments.

Für kleinere Korrekturen oder Klarstellungen zu Dokumentation und Codebeispielen in öffentlichen Repositorys gelten die Nutzungsbestimmungen zu docs.microsoft.com.Minor corrections or clarifications to documentation and code examples in public repositories are covered by the docs.microsoft.com Terms of Use. Neue oder signifikante Änderungen haben einen Kommentar im Pull Request zur Folge, in dem Sie gebeten werden, online eine Lizenzvereinbarung für Beiträge (Contribution License Agreement, CLA) zu akzeptieren. Dies gilt, wenn Sie kein Mitarbeiter von Microsoft sind.New or significant changes generate a comment in the pull request, asking you to submit an online Contribution License Agreement (CLA) if you are not an employee of Microsoft. Sie müssen das Onlineformular ausfüllen, damit wir Ihren Pull Request prüfen oder annehmen können.We need you to complete the online form before we can review or accept your pull request.

Schnelle Änderungen an vorhandenen DokumentenQuick edits to existing documents

Schnelle Änderungen optimieren das Melden und Beheben von geringfügigen Fehlern und Auslassungen in Dokumenten.Quick edits streamline the process to report and fix small errors and omissions in documents. Trotz aller Bemühungen kommt es zu geringfügigen Grammatik- und Rechtschreibfehlern in unseren Dokumenten.Despite all efforts, small grammar and spelling errors do make their way into our published documents. Sie können Tickets erstellen, um Fehler zu melden – es ist jedoch schneller und einfacher, einen Pull Request (PR) zum Beheben des Fehlers zu erstellen, wenn diese Option verfügbar ist.While you can create issues to report mistakes, it's faster and easier to create a pull request (PR) to fix the issue, when the option is available.

  1. Einige Seiten der Dokumentation ermöglichen es Ihnen, Inhalte direkt im Browser zu bearbeiten.Some docs pages allow you to edit content directly in the browser. Wenn dies der Fall ist, wird eine Schaltfläche Bearbeiten angezeigt, wie unten gezeigt.If so, you'll see an Edit button like the one shown below. Wenn Sie auf Bearbeiten klicken, werden Sie zur Quelldatei auf GitHub weitergeleitet.Clicking the Edit (or equivalently localized) button takes you to the source file on GitHub. Wenn die Schaltfläche Bearbeiten fehlt, bedeutet dies, dass die Dokumentationsseite nicht für Änderungen verfügbar ist.If the Edit button is missing, that means the documentation page is not available to be changed.

    Ort des Links „Bearbeiten“

  2. Klicken Sie anschließend auf das Stiftsymbol, um den Artikel wie gezeigt zu bearbeiten.Next, click the pencil icon, to edit the article as shown. Wenn das Stiftsymbol abgeblendet ist, müssen Sie sich mit Ihrem GitHub-Konto anmelden oder ein neues Konto erstellen.If the pencil icon is grayed out, you need to either log in to your GitHub account or create a new account.

    Ort des Bleistiftsymbols

  3. Nehmen Sie im Web-Editor die Änderungen vor.Make your changes in the web editor. Klicken Sie auf die Registerkarte Preview changes (Vorschau der Änderungen), um sich das Format Ihrer Änderungen anzusehen.Click the Preview changes tab to check the formatting of your change.

  4. Wenn Sie alle gewünschten Änderungen vorgenommen haben, scrollen Sie auf der Seite ganz nach unten.Once you have made your changes, scroll to the bottom of the page. Geben Sie einen Titel und eine Beschreibung für Ihre Änderungen ein, und klicken Sie wie unten dargestellt auf Propose file change (Dateiänderung vorschlagen):Enter a title and description for your changes and click Propose file change as shown in the following figure:

    Propose file change

  5. Jetzt haben Sie Ihre Änderungen vorgeschlagen und müssen die Besitzer des Repositorys bitten, Ihre Änderungen in ihr Repository zu „pullen“.Now that you've proposed your change, you need to ask the owners of the repository to "pull" your changes into their repository. Dies erfolgt mit einem sogenannten „Pull Request“.This is done using something called a "pull request". Wenn Sie in der oberen Abbildung auf Propose file change geklickt haben, müssten Sie zu einer neuen Seite gelangt sein, die folgender Abbildung entspricht:When you clicked on Propose file change in the figure above, you should have been taken to a new page that looks like the following figure:

    Pull Request erstellen

    Klicken Sie auf Create pull request (Pull Request erstellen), geben Sie einen Titel (und optional eine Beschreibung) für den Pull Request ein, und klicken erneut auf Create pull request.Click Create pull request, enter a title (and optionally a description) for the pull request, and then click Create pull request again. (Wenn Sie neu bei GitHub sind, finden Sie unter About Pull Requests (Über Pull Requests) wichtige Informationen zum Einstieg.)(If you are new to GitHub, see About Pull Requests for more information.)

  6. Das ist alles!That's it! Das Inhaltsteam sieht sich Ihren PR an und mergt ihn bei Bedarf.Content team members will review and merge your PR. Wenn Sie größere Änderungen vorgeschlagen haben, erhalten Sie möglicherweise eine Anfrage zum Vornehmen von Änderungen.You may get some feedback requesting changes if you made larger changes.

Die GitHub-Benutzeroberfläche zum Bearbeiten spiegelt Ihre Berechtigungen für das Repository wider.The GitHub editing UI responds to your permissions on the repository. Die oben aufgeführten Abbildungen gelten für Mitwirkende, die keine Schreibberechtigungen für das Zielrepository haben.The preceding images are accurate for contributors that do not have write permissions to the target repository. GitHub erstellt automatisch einen Fork des Zielrepositorys in Ihrem Konto.GitHub automatically creates a fork of the target repository in your account. Wenn Sie Schreibberechtigungen für das Zielrepository haben, erstellt GitHub einen neuen Branch im Zielrepository.If you have write-access to the target repository, GitHub creates a new branch in the target repo. Der Branchname folgt dem Format <GitHubId>-patch-n mit Ihrer GitHub-ID und einem numerischen Bezeichner für den Patchbranch.The branch name has the form <GitHubId>-patch-n using your GitHub ID, and a numeric identifier for the patch branch.

Wir verwenden Pull Requests für alle Änderungen, auch für Mitwirkende mit Schreibberechtigungen.We use pull requests for all changes, even for contributors that have write-access. In den meisten Repositorys ist der master-Branch geschützt, damit Änderungen als Pull Requests vorgeschlagen werden.Most repositories have the master branch protected so that updates must be submitted as pull requests.

Das Bearbeiten im Browser eignet sich am besten für geringfügige oder seltene Änderungen.The in-browser editing experience is best for minor or infrequent changes. Wenn Sie umfangreichere Änderungen vornehmen oder erweiterte Git-Features verwenden (z.B die Branchverwaltung oder erweiterte Auflösung von Mergekonflikten), müssen Sie einen Fork für das Repository erstellen und lokal arbeiten.If you make large contributions or use advanced Git features (such as branch management or advanced merge conflict resolution), you need to fork the repo and work locally.

Note

Falls aktiviert, können Sie einen Artikel in einer beliebigen Sprache bearbeiten und, je nach Typ der Bearbeitung, geschieht Folgendes:If enabled, you can edit an article in any language and, based on the type of edit, the following will happen:

  1. Jede sprachliche Änderung, die genehmigt wird, dient auch der Verbesserung unserer Maschinenübersetzungs-Engine.any linguistic change that is approved, will also help improve our Machine Translation engine
  2. Jede Bearbeitung, die den Inhalt des Artikels signifikant ändert, wird intern verarbeitet, um eine Änderung desselben Artikels in Englisch zu übermitteln, sodass sie bei Genehmigung in allen Sprachen lokalisiert wird.any edit that significantly modifies the content of the article will be handled internally to submit a change to the same article in English so that it will get localized in all languages if approved. Die von Ihnen vorgeschlagenen Verbesserungen haben nicht nur positive Auswirkungen auf Artikel in Ihrer eigenen, sondern in allen verfügbaren Sprachen.Your suggested improvements will not only positively affect articles in your own language, but in all available languages.

Prüfen offener PRsReview open PRs

Sie können neue Artikel vor der Veröffentlichung lesen, indem Sie sich die aktuell offenen PRs ansehen.You can read new topics before they are published by checking the currently open PRs. Diese Prüfung folgt dem GitHub-Flow.Reviews follow the GitHub flow process. Sie können sich vorgeschlagene Änderungen oder neue Artikel in öffentlichen Repositorys ansehen.You can see proposed updates or new articles in public repositories. Prüfen Sie diese, und fügen Sie eigene Kommentare hinzu.Review them and add your comments. Sie können beliebige Dokumentationsrepositorys aufrufen und sich offene Pull Requests für Themenbereiche ansehen, die Sie interessieren.Look at any of our docs repositories, and check the open pull requests (PRs) for areas that interest you. Vom Feedback der Community zu vorgeschlagenen Änderungen profitiert die gesamte Community.Community feedback on proposed updates helps the entire community.

Erstellen nützlicher TicketsCreate quality issues

Unsere Dokumentationen können fortlaufend geändert und verbessert werden.Our docs are a continuous work in progress. Mit nützlichen Tickets können wir uns immer auf das konzentrieren, was für die Community am wichtigsten ist.Good issues help us focus our efforts on the highest priorities for the community. Je ausführlicher die Informationen im Ticket, desto nützlicher ist dieses für uns.The more detail you can provide, the more helpful the issue. Sagen Sie uns, welche Informationen Sie gesucht haben.Tell us what information you sought. Nennen Sie uns die Suchbegriffe, die Sie verwendet haben.Tell us the search terms you used. Wenn Ihnen der Einstieg schwerfällt, dann sagen Sie uns einfach, wie Sie sich am liebsten mit neuen Technologien vertraut machen würden.If you can't get started, tell us how you want to start exploring unfamiliar technology.

Viele der Dokumentationsseiten von Microsoft weisen unten auf der Seite einen Abschnitt Feedback auf, in dem Sie auf Produktfeedback oder Inhaltsfeedback klicken können, um Probleme nachzuverfolgen, die spezifisch für diesen Artikel sind.Many of Microsoft's documentation pages have a Feedback section at the bottom of the page where you can click to leave Product feedback or Content feedback to track issues that are specific to that article.

Durch Tickets erfahren wir, wo Verbesserungsbedarf besteht.Issues start the conversation about what's needed. Das Inhaltsteam reagiert dann auf diese Tickets mit Veränderungsvorschlägen und holt Ihre Meinung dazu ein.The content team will respond to these issues with ideas for what we can add, and ask for your opinions. Nachdem wir einen Entwurf veröffentlicht haben, können Sie den PR prüfen.When we create a draft, we'll ask you to review the PR.

Beteiligen Sie sichGet more involved

In anderen Artikeln erhalten Sie Informationen zum produktiven Mitwirken an der Microsoft-Dokumentation. Dort erfahren Sie, wie Sie mit GitHub-Repositorys, Markdown-Tools und Erweiterungen der Plattform für Microsoft-Dokumentationen arbeiten können.Other topics help you get started productively contributing to Microsoft Docs. They explain working with GitHub repositories, Markdown tools, and extensions used in the Microsoft Docs platform.