Gids voor inzenders van Microsoft Docs: overzichtMicrosoft Docs contributor guide overview

Welkom bij de stijlgids voor docs.microsoft.com (ook bekend als Docs).Welcome to the docs.microsoft.com (Docs) Contributor Guide!

Meerdere van onze documentatiesets zijn opensourcesets die worden gehost op GitHub.Several of our documentation sets are open source, hosted on GitHub. Steeds meer teams bij Microsoft stappen over op dit model.More teams at Microsoft are adopting this model all the time. Zelfs documentatiessets die niet volledig open source zijn, hebben een openbare opslagplaats waarvoor u pull-aanvragen kunt maken.Even document sets that are not completely open source have public-facing repos where you are invited to make pull requests. Zo kan de communicatie tussen productengineers, de inhoudsteams en onze klanten worden gestroomlijnd en verbeterd.It streamlines and improves communication between the product engineers, the content teams, and our customers. In het openbaar werken biedt verschillende voordelen:Working in the open provides several advantages:

  • Met openbare planning in opensourceopslagplaatsen kan feedback worden verkregen over welke documenten het meest nodig zijn.Open source repos plan in the open to get feedback on what docs are most needed.
  • Met openbare controles in opensourceopslagplaatsen kan de inhoud die het nuttigst is, in de eerste versie worden gepubliceerd.Open source repos review in the open to publish the most helpful content on our first release.
  • Met openbare updates in opensourceopslagplaatsen is het eenvoudiger om de inhoud doorlopend te verbeteren.Open source repos update in the open to make it easier to continuously improve the content.

De gebruikerservaring op docs.microsoft.com is rechtstreeks geïntegreerd met werkstromen van GitHub om dit nog eenvoudiger te maken.The user experience on docs.microsoft.com integrates GitHub workflows directly to make it even easier. U kunt beginnen door het document te bewerken dat u bekijkt.Start by editing the document you are viewing. Of u kunt helpen door nieuwe onderwerpen te beoordelen of kwaliteitsproblemen te melden.Or, help by reviewing new topics, or create quality issues.

Belangrijk

Op alle opslagplaatsen die naar docs.microsoft.com publiceren, is de Microsoft Open Source-gedragscode of de .NET Foundation-gedragscode van toepassing.All repositories that publish to docs.microsoft.com have adopted the Microsoft Open Source Code of Conduct or the .NET Foundation Code of Conduct. Zie Veelgestelde vragen over de gedragscode voor meer informatie.For more information, see the Code of Conduct FAQ. Of neem contact op via opencode@microsoft.com of conduct@dotnetfoundation.org als u vragen of opmerkingen hebt.Or contact opencode@microsoft.com, or conduct@dotnetfoundation.org with any questions or comments.

Kleine correcties of verduidelijkingen voor de documentatie en codevoorbeelden in de openbare opslagplaatsen vallen onder de gebruiksvoorwaarden van 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. Bij nieuwe inhoud of belangrijke wijzigingen wordt een opmerking gegenereerd in de pull-aanvraag, waarin u wordt gevraagd om online een gebruiksrechtovereenkomst voor bijdrage (CLA) in te dienen als u geen werknemer van Microsoft bent.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. U moet het onlineformulier invullen voordat we uw pull-aanvraag kunnen beoordelen of accepteren.We need you to complete the online form before we can review or accept your pull request.

Snelle bewerkingen van bestaande documentenQuick edits to existing documents

Met snelle bewerkingen wordt het proces voor het rapporteren en herstellen van kleine fouten en weglatingen in documenten gestroomlijnd.Quick edits streamline the process to report and fix small errors and omissions in documents. Ondanks alle moeite kunnen toch kleine grammatica- en spelfouten in uw gepubliceerde documenten opduiken.Despite all efforts, small grammar and spelling errors do make their way into our published documents. Hoewel u fouten kunt rapporteren via probleemmeldingen, kunt u dit sneller en eenvoudiger doen door een pull-aanvraag (PR) te maken om het probleem te verhelpen.While you can create issues to report mistakes, it's faster and easier to create a pull request (PR) to fix the issue. Bij bijna elk artikel wordt een knop Bewerken weergegeven, zoals in de volgende afbeelding wordt getoond.Almost every article displays an edit button as shown in the following figure. Wanneer u op de knop Bewerken (of de gelokaliseerde equivalent hiervan) klikt, gaat u naar het bronbestand op GitHub.Clicking the Edit (or equivalent localized) button takes you to the source file on GitHub.

Locatie van de link Bewerken

Klik op het potloodpictogram dat is weergegeven in de volgende afbeelding om het artikel te bewerken.Next, click the pencil icon, shown in the following figure to edit the article.

Notitie

Als het potloodpictogram grijs wordt weergegeven, moet u bij uw GitHub-account aanmelden of een nieuw account maken.If the pencil icon is grayed out, you need to login to your GitHub account, or create a new account. Breng uw wijzigingen aan in de webeditor.Make your changes in the web editor. U kunt op het tabblad Voorbeeld van wijzigingen klikken om de opmaak van uw wijziging te controleren.You can click the Preview changes tab to check formatting of your change.

Locatie van het potloodpictogram

Zodra u uw wijzigingen hebt aangebracht, scrolt u naar de onderkant van de pagina.Once you have made your changes, scroll to the bottom of the page. Voer een titel en een beschrijving in voor uw PR en klik op Bestandswijziging voorstellen, zoals is weergegeven in de volgende afbeelding:Enter a title and description for your PR and click Propose file change as shown in the following figure:

uw wijziging voorstellen

Nu u de wijziging hebt voorgesteld, moet u de eigenaars van de opslagplaats vragen om de wijzigingen naar hun opslagplaats te halen.Now that you've proposed your change, you need to ask the owners of the repository to "pull" your changes into their repository. Dit gebeurt met een zogenaamde pull-aanvraag.This is done using something called a "pull request". Wanneer u in de afbeelding hierboven op Bestandswijziging voorstellen klikt, wordt u naar een nieuwe pagina geleid die er ongeveer uitziet als de volgende afbeelding: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-aanvraag maken

Klik op Pull-aanvraag maken, voer een titel (en optioneel een beschrijving) in voor de pull-aanvraag. Klik vervolgens opnieuw op Pull-aanvraag maken.Click Create pull request, enter a title (and optionally a description) for the pull request, and then click Create pull request again.

Dat is alles.That's it! Uw PR wordt door leden van het inhoudsteam gecontroleerd en samengevoegd.Content team members will review and merge your PR. Als u grotere wijzigingen hebt aangebracht, krijgt u misschien feedback waarin u wordt gevraagd om wijzigingen aan te brengen.You may get some feedback requesting changes if you made larger changes.

De gebruikersinterface voor GitHub-bewerkingen reageert op uw machtigingen voor de opslagplaats.The GitHub editing UI responds to your permissions on the repository. De voorgaande afbeeldingen gelden voor inzenders die geen schrijfmachtigingen hebben voor de doelopslagplaats.The preceding images are accurate for contributors that do not have write permissions to the target repository. In GitHub wordt automatisch een fork van de doelopslagplaats gemaakt in uw account.GitHub automatically creates a fork of the target repository in your account. Als u schrijfrechten hebt voor de doelopslagplaats, wordt in GitHub een nieuwe vertakking in de doelopslagplaats gemaakt.If you have write access to the target repository, GitHub creates a new branch in the target repo. De naam van de vertakking heeft de indeling <GitHubId>-patch-n, waarbij uw GitHub-id en een numerieke id worden gebruikt voor de vertakking van de patch.The branch name has the form <GitHubId>-patch-n using your GitHub ID, and a numeric identifier for the patch branch.

De PR's worden gebruikt voor alle wijzigingen en dus ook voor inzenders die over schrijfrechten beschikken.We use PRs for all changes, even for contributors that have write access. Bij de meeste opslagplaatsen is de master-vertakking beschermd, zodat updates als PR's moeten worden verzonden.Most repositories have the master branch protected so that updates must be submitted as PRs.

Voor kleinere of incidentele wijzigingen kunt u het beste de bewerkingservaring binnen browsers gebruiken.The in-browser editing experience is best for minor or infrequent changes. Als u grote bijdrage levert of geavanceerde Git-functies gebruikt (zoals vertakkingsbeheer of geavanceerde oplossingen voor samenvoegingsconflicten), moet u de opslagplaats splitsen en lokaal werken.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.

Notitie

Als deze functie is ingeschakeld, kunt u een artikel in elke taal bewerken. Afhankelijk van het soort bewerking gebeurt dan het volgende:If enabled, you can edit an article in any language and, based on the type of edit, the following will happen:

  1. elke taalkundige wijziging die is doorgevoerd, helpt ook bij het verbeteren van onze Machine Translation-engineany linguistic change that is approved, will also help improve our Machine Translation engine
  2. elke bewerking waardoor de inhoud van een artikel significant wordt gewijzigd, wordt intern verwerkt om een wijziging in hetzelfde artikel in het Engels te verzenden. Op deze manier wordt de wijziging, indien goedgekeurd, in alle talen gelokaliseerd.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. Uw voorgestelde wijzigingen beïnvloeden artikelen dus niet alleen positief in uw eigen taal, maar in alle beschikbare talen.So your suggested improvements will not only positively affect articles in your own language, but in all avaliable languages.

Openstaande PR's controlerenReview open PRs

U kunt nieuwe onderwerpen lezen voordat deze zijn gepubliceerd door de momenteel openstaande PR's te controleren.You can read new topics before they are published by checking the currently open PRs. Bij controles wordt het proces van de GitHub-workflow gevolgd.Reviews follow the GitHub flow process. U kunt voorgestelde updates of nieuwe artikelen in openbare opslagplaatsen bekijken.You can see proposed updates or new articles in public repositories. Controleer deze en voeg uw opmerkingen toe.Review them and add your comments. Ga naar onze opslagplaatsen voor documentatie en bekijk de openstaande pull-aanvragen voor gebieden die interessant zijn voor u.Look at any of our docs repositories, and check the open pull requests (PRs) for areas that interest you. Feedback uit de community over voorgestelde updates is nuttig voor de gehele community.Community feedback on proposed updates helps the entire community.

Kwaliteitsproblemen makenCreate quality issues

Onze documentatie wordt doorlopend aangevuld en verbeterd.Our docs are a continuous work in progress. Dankzij goede probleemmeldingen kunnen we onze inspanningen richten op de hoogste prioriteiten van de community.Good issues help us focus our efforts on the highest priorities for the community. Hoe gedetailleerder deze zijn, des te nuttiger is de probleemmelding.The more detail you can provide, the more helpful the issue. Vertel ons naar welke informatie u op zoek was.Tell us what information you sought. Vertel ons welke zoektermen u hebt gebruikt.Tell us the search terms you used. Vertel ons, als u niet aan de slag kunt, hoe u wilt beginnen met het verkennen van onbekende technologie.If you can't get started, tell us how you want to start exploring unfamiliar technology.

Probleemmeldingen zijn het startpunt om te bespreken wat er nodig is.Issues start the conversation about what's needed. Het inhoudsteam reageert op deze probleemmeldingen met ideeën over wat we kunnen toevoegen, en vraagt om uw mening.The content team will respond to these issues with ideas for what we can add, and ask for your opinions. Wanneer we een concept maken, vragen we u om de PR te beoordelen.When we create a draft, we'll ask you to review the PR.

Meer betrokken rakenGet more involved

Er zijn onderwerpen beschikbaar die u kunt gebruiken om productief bij te dragen aan Microsoft Docs. In deze onderwerpen wordt uitgelegd hoe u werkt met GitHub-opslagplaatsen, Markdown-hulpprogramma's en de extensies die worden gebruikt voor het Microsoft Docs-platform.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.