Feedback

Bidra till PowerShell-dokumentationen

  • Artikel
  • 2 minuter för att läsa

Tack för ditt stöd för PowerShell!

Deltagarguiden är en samling artiklar som beskriver de verktyg och processer som vi använder för att skapa dokumentation på Microsoft. Några av dessa guider omfattar information som är gemensam för all dokumentation som publiceras till docs.microsoft.com . Vissa av vägledningarna är specifika för hur vi skriver dokumentation för PowerShell.

De vanliga artiklarna finns i vår centraliserade deltagarguide. De PowerShell-specifika guiderna finns här.

Sätt att bidra

Det finns två sätt att bidra. Båda bidragen är värdefulla för oss.

  • Med registreringsproblem kan vi identifiera problem och luckor i vår dokumentation. Ibland kan problemen vara svåra att lösa, vilket kräver mer undersökning och forskning. Med problemprocessen kan vi föra en konversation om problemet och utveckla en tillfredsställande lösning.

  • Att skicka en pull-begäran för att lägga till eller ändra innehåll är en mer inblandande process. Följande information beskriver verktyg, processer och standarder för att skicka innehåll till dokumentationen.

Förbered för att göra ett bidrag

Du behöver ett GitHub-konto för att bidra till dokumentationen. Använd följande checklista för att installera och konfigurera de verktyg som du behöver för att göra bidrag.

  1. Registrera dig för GitHub
  2. Installera Git- och Markdown-verktyg
  3. Installera Docs-redigeringspaketet
  4. Installera Posh-Git – krävs inte men rekommenderas
  5. Konfigurera en lokal Git-lagringsplats
  6. Granska grunderna i Git GitHub och -principer

Komma igång med att skriva dokument

Det finns två sätt att bidra med ändringar i dokumentationen:

  1. Snabbredigeringar i befintliga dokument
    • Mindre korrigeringar, korrigering av stavfel eller små tillägg
  2. Fullständigt GitHub arbetsflöde för dokument
    • stora ändringar, flera versioner, lägga till eller ändra bilder eller bidra med nya artiklar

Läs även avsnittet Om att skriva i den centraliserade deltagarguiden. En annan utmärkt resurs är Microsoft Writing Style Guide. Målet med Microsoft Writing Style Guide är att hjälpa redigerare, tekniska skrivare, utvecklare, marknadsförare och andra inom IT att skriva bättre innehåll.

Mindre korrigeringar eller förtydliganden av dokumentation och kodexempel på offentliga lagringsplatsen omfattas docs.microsoft.com användningsvillkoren.

Använd det fullständiga GitHub arbetsflödet när du gör betydande ändringar. Om du inte är anställd på Microsoft genererar betydande ändringar en kommentar i pull-begäran som ber dig att skicka in ett licensavtal för bidrag (CLA)online. Du måste fylla i hela online-formuläret innan vi kan granska eller acceptera din pull-begäran.

Uppförandekod

Alla informationslager som publicerar till docs.microsoft.com har antagit Microsoft Open Source-uppförandekoden eller .NET Foundation-uppförandekoden. Mer information finns i vanliga frågor och svar om uppförandekoden.

Nästa steg

Följande artiklar innehåller information som är specifik för PowerShell-dokumentationen. Om det finns överlappningar med vägledningen i den centraliserade deltagarguiden kan vi påpeka hur dessa regler skiljer sig åt för PowerShell-innehållet.

Läs följande dokument:

Ytterligare resurser