Gids voor inzenders van Microsoft Docs: overzicht

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

Meerdere Microsoft-documentatiesets zijn open source en worden gehost op GitHub. Niet alle documentatiesets zijn volledig open source, maar vele hebben een openbare opslagplaats waar u aanbevolen wijzigingen kunt aanbrengen via pull-aanvragen. Deze open source-benadering stroomlijnt en verbetert niet alleen de communicatie tussen productengineers, inhoudsteams en klanten, maar biedt ook nog andere 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 er toch kleine grammatica- en spelfouten in onze gepubliceerde documenten opduiken. U kunt fouten rapporteren door een probleemmelding te maken. Als deze optie beschikbaar is, kunt u problemen echter ook melden via een pull-aanvraag. Dat is sneller en eenvoudiger.

  1. Op sommige documentatiepagina's kunt u rechtstreeks in de browser inhoud bewerken. Als dat het geval is, wordt de knop Bewerken weergegeven. Zie het voorbeeld hieronder. Wanneer u op de knop Bewerken klikt, gaat u naar het bronbestand op GitHub. Als u de knop Bewerken niet ziet, betekent dit dat de documentatiepagina niet kan worden gewijzigd.

    Locatie van de koppeling Bewerken

    Als de knop Bewerken niet wordt weergegeven, betekent dit dat de inhoud niet is geopend voor openbare bijdragen.

  2. Selecteer het potloodpictogram om het artikel te bewerken. Als het potloodpictogram grijs wordt weergegeven, moet u zich bij uw GitHub-account aanmelden of een nieuw account maken.

    Locatie van het potloodpictogram

  3. Wijzigingen aanbrengen in de webeditor. Klik op Voorbeeld van wijzigingen om de opmaak van uw wijziging te controleren.

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

    Bestandswijziging voorstellen

  5. Nu u de wijziging hebt voorgesteld, moet u de eigenaars van de opslagplaats vragen om de wijzigingen naar hun opslagplaats te halen. Dit gebeurt met een zogenaamde pull-aanvraag. Wanneer u Bestandswijziging voorstellen selecteert, wordt een nieuwe pagina weergegeven die vergelijkbaar is met de volgende:

    pull-aanvraag maken

    Selecteer Pull-aanvraag maken, voer een titel en eventueel een beschrijving in voor de pull-aanvraag en selecteer vervolgens Pull-aanvraag maken. Zie About Pull Requests (Informatie over pull-aanvragen) voor meer informatie als u niet weet wat GitHub is.

  6. Dat is alles. Leden van het inhoudsteam beoordelen en voegen uw pr samen wanneer deze is goedgekeurd. U kunt feedback krijgen om wijzigingen aan te vragen.

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 pull-aanvragen worden gebruikt voor alle wijzigingen en dus ook voor inzenders die over schrijfrechten beschikken. De meeste opslagplaatsen hebben de standaardvertakking beveiligd, zodat updates moeten worden verzonden als pull-aanvragen.

Voor kleinere of incidentele wijzigingen kunt u het beste de bewerkingservaring binnen browsers gebruiken. Als u grote bijdragen levert of geavanceerde Git-functies gebruikt (zoals vertakkingsbeheer of geavanceerde oplossingen voor samenvoegingsconflicten), moet u de opslagplaats splitsen en lokaal werken.

Notitie

De meeste gelokaliseerde documentatie biedt niet de mogelijkheid om deze te bewerken of feedback te geven via GitHub. Als u feedback wilt geven over gelokaliseerde inhoud, gebruikt u de e-mailsjabloon die beschikbaar is aka.ms/DocSiteLocFeedback. Er is één uitzondering voor Azure-documentatie. Er zijn openbare, gelokaliseerde GitHub-opslagplaatsen voor azure-docs die zijn geopend voor bijdragen van de community voor zes talen: Vereenvoudigd Chinees, Frans, Duits, Japans, Koreaans en Spaans. Gebruik voor alle andere talen en inhoudssets de e-mailsjabloon (dieuw invoer in elke taal ontvangt) om vertaalproblemen te melden of technische feedback te geven.

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.

Veel van de documentatiepagina's van Microsoft bevatten onderaan een gedeelte Feedback. Hier kunt u op klikken om productfeedback of inhoudsfeedback te geven met betrekking tot problemen in het artikel.

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.