Feedback

Bijdragen aan PowerShell-documentatie

  • Artikel
  • 2 minuten om te lezen

Bedankt voor uw ondersteuning van PowerShell.

De gids voor inzenders is een verzameling artikelen waarin de hulpprogramma's en processen worden beschreven die we gebruiken om documentatie bij Microsoft te maken. Sommige van deze handleidingen hebben betrekking op informatie die gebruikelijk is voor elke documentatieset die is gepubliceerd naar docs.microsoft.com . Sommige gidsen zijn specifiek voor het schrijven van documentatie voor PowerShell.

De algemene artikelen zijn beschikbaar in onze gecentraliseerde gids voor inzenders. De PowerShell-specifieke handleidingen zijn hier beschikbaar.

Manieren om bij te dragen

Er zijn twee manieren om bij te dragen. Beide bijdragen zijn waardevol voor ons.

  • Het indienen van problemen helpt ons bij het identificeren van problemen en hiaten in onze documentatie. Soms zijn de problemen moeilijk op te lossen, wat meer onderzoek en onderzoek vereist. Het probleemproces stelt ons in staat om een gesprek over het probleem te voeren en een goede oplossing te ontwikkelen.

  • Het indienen van een pull-aanvraag om inhoud toe te voegen of te wijzigen is een meer betrokken proces. De volgende informatie bevat een overzicht van de hulpprogramma's, processen en standaarden voor het indienen van inhoud bij de documentatie.

Voorbereiden op het maken van een bijdrage

U hebt allereerst een GitHub-account nodig om bij te dragen aan de documentatie. Gebruik de volgende controlelijst om de hulpprogramma's te installeren en te configureren die u nodig hebt om bijdragen te leveren.

  1. Registreren voor GitHub
  2. Hulpprogramma's voor Git/Markdown installeren
  3. Het Docs Authoring Pack installeren
  4. Posh-Git installeren - niet vereist maar aanbevolen
  5. Een lokale Git-opslagplaats instellen
  6. De basisprincipes van Git GitHub lezen

Aan de slag met het schrijven van documentatie

Er zijn twee manieren om wijzigingen aan de documentatie bij te dragen:

  1. Snelle bewerkingen van bestaande documenten
    • Kleine correcties, het oplossen van typfouten of kleine toevoegingen
  2. Volledige GitHub voor documenten
    • grote wijzigingen, meerdere versies, toevoegen of wijzigen van afbeeldingen of bijdragen aan nieuwe artikelen

Lees ook de sectie Belangrijke informatie over het schrijven van de gecentraliseerde gids voor inzenders. Een andere uitstekende resource is de Microsoft Writing Style Guide. Het doel van de Microsoft Writing Style Guide is om editors, technische schrijvers, ontwikkelaars, marketeers en anderen in IT te helpen betere inhoud te schrijven.

Kleine correcties of verduidelijkingen van documentatie en codevoorbeelden in openbare opslagplaatsen vallen onder de docs.microsoft.com gebruiksvoorwaarden.

Gebruik de volledige GitHub wanneer u belangrijke wijzigingen aan het aanbrengen bent. Als u geen werknemer van Microsoft bent, genereren belangrijke wijzigingen een opmerking in de pull-aanvraag waarin u wordt gevraagd een online Contribution Licensing Agreement (CLA) in te dienen. U moet het onlineformulier invullen voordat we uw pull-aanvraag kunnen beoordelen of accepteren.

Gedragscode

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.

Volgende stappen

De volgende artikelen bevatten informatie die specifiek is voor PowerShell-documentatie. Waar er overlap is met de richtlijnen in de handleiding voor gecentraliseerde inzenders, noemen we hoe deze regels verschillen voor de PowerShell-inhoud.

Bekijk de volgende documenten:

Aanvullende bronnen