Gids voor inzenders van Microsoft Docs: overzicht

Welkom bij de stijlgids voor docs.microsoft.com (ook bekend als Docs).

Meerdere van onze documentatiesets zijn opensourcesets die worden gehost op GitHub. Er zijn steeds meer teams die dit model invoeren. Zelfs documentatiessets die niet volledig open source zijn, hebben een openbare opslagplaats waarvoor u pull-aanvragen kunt maken. Zo kan de communicatie tussen productengineers, de inhoudsteams en onze klanten worden gestroomlijnd en verbeterd. In het openbaar werken biedt verschillende voordelen:

  • Met openbare planning in opensourceopslagplaatsen kan feedback worden verkregen over welke documenten het meest nodig zijn.
  • Met openbare controles in opensourceopslagplaatsen kan de inhoud die het nuttigst is, in de eerste versie worden gepubliceerd.
  • Met openbare updates in opensourceopslagplaatsen is het eenvoudiger om de inhoud doorlopend te verbeteren.

De gebruikerservaring op docs.microsoft.com is rechtstreeks geïntegreerd met werkstromen van GitHub om dit nog eenvoudiger te maken. U kunt beginnen door het document te bewerken dat u bekijkt. Of u kunt helpen door nieuwe onderwerpen te beoordelen of kwaliteitsproblemen te melden.

Belangrijk

Op alle opslagplaatsen die naar docs.microsoft.com publiceren, is de Microsoft Open Source-gedragscode of de .NET Foundation-gedragscode van toepassing. Zie Veelgestelde vragen over de gedragscode voor meer informatie. Of neem contact op via opencode@microsoft.com of conduct@dotnetfoundation.org als u vragen of opmerkingen hebt.

Kleine correcties of verduidelijkingen voor de documentatie en codevoorbeelden in de openbare opslagplaatsen vallen onder de gebruiksvoorwaarden van docs.microsoft.com. 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. U moet het onlineformulier invullen voordat we uw pull-aanvraag kunnen beoordelen of accepteren.

Snelle bewerkingen van bestaande documenten

Met snelle bewerkingen wordt het proces voor het rapporteren en herstellen van kleine fouten en weglatingen in documenten gestroomlijnd. Ondanks alle moeite kunnen toch kleine grammatica- en spelfouten in uw gepubliceerde documenten opduiken. 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. Bij bijna elk artikel wordt een knop Bewerken weergegeven, zoals in de volgende afbeelding wordt getoond. Wanneer u op de knop Bewerken klikt, gaat u naar het bronbestand op GitHub.

Locatie van de link Bewerken

Klik op het potloodpictogram dat is weergegeven in de volgende afbeelding om het artikel te bewerken.

Notitie

Als het potloodpictogram grijs wordt weergegeven, moet u bij uw GitHub-account aanmelden of een nieuw account maken. Breng uw wijzigingen aan in de webeditor. U kunt op het tabblad Voorbeeld van wijzigingen klikken om de opmaak van uw wijziging te controleren.

Locatie van het potloodpictogram

Zodra u uw wijzigingen hebt aangebracht, scrolt u naar de onderkant van de pagina. Voer een titel en een beschrijving in voor uw PR en klik op Bestandswijziging voorstellen, zoals is weergegeven in de volgende afbeelding:

uw wijziging voorstellen

Dat is alles. Uw PR wordt door leden van het inhoudsteam gecontroleerd en samengevoegd. Als u grotere wijzigingen hebt aangebracht, krijgt u misschien feedback waarin u wordt gevraagd om wijzigingen aan te brengen.

De gebruikersinterface voor GitHub-bewerkingen reageert op uw machtigingen voor de opslagplaats. De voorgaande afbeeldingen gelden voor inzenders die geen schrijfmachtigingen hebben voor de doelopslagplaats. In GitHub wordt automatisch een fork van de doelopslagplaats gemaakt in uw account. Als u schrijfrechten hebt voor de doelopslagplaats, wordt in GitHub een nieuwe vertakking in de doelopslagplaats gemaakt. 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.

De PR's worden gebruikt voor alle wijzigingen en dus ook voor inzenders die over schrijfrechten beschikken. Bij de meeste opslagplaatsen is de master-vertakking beschermd, zodat updates als PR's moeten worden verzonden.

Voor kleinere of incidentele wijzigingen kunt u het beste de bewerkingservaring binnen browsers gebruiken. 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.

Openstaande PR's controleren

U kunt nieuwe onderwerpen lezen voordat deze zijn gepubliceerd door de momenteel openstaande PR's te controleren. Bij controles wordt het proces van de GitHub-workflow gevolgd. U kunt voorgestelde updates of nieuwe artikelen in openbare opslagplaatsen bekijken. Controleer deze en voeg uw opmerkingen toe. Ga naar onze opslagplaatsen voor documentatie en bekijk de openstaande pull-aanvragen voor gebieden die interessant zijn voor u. Feedback uit de community over voorgestelde updates is nuttig voor de gehele community.

Kwaliteitsproblemen maken

Onze documentatie wordt doorlopend aangevuld en verbeterd. Dankzij goede probleemmeldingen kunnen we onze inspanningen richten op de hoogste prioriteiten van de community. Hoe gedetailleerder deze zijn, des te nuttiger is de probleemmelding. Vertel ons naar welke informatie u op zoek was. Vertel ons welke zoektermen u hebt gebruikt. Vertel ons, als u niet aan de slag kunt, hoe u wilt beginnen met het verkennen van onbekende technologie.

Probleemmeldingen zijn het startpunt om te bespreken wat er nodig is. Het inhoudsteam reageert op deze probleemmeldingen met idee├źn over wat we kunnen toevoegen, en vraagt om uw mening. Wanneer we een concept maken, vragen we u om de PR te beoordelen.

Meer betrokken raken

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.