Feedback

Kom igång bidra till PowerShell-dokumentationen

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

Den här artikeln är en översikt över hur du kommer igång med att bidra till PowerShell-dokumentationen.

PowerShell-Docs struktur

PowerShell-Docs-lagringsplatsen är indelad i två innehållsgrupper: referens och konceptuell.

Referensinnehåll

Referensinnehållet är PowerShell-cmdlet-referensen för de cmdletar som levereras i PowerShell. Referensen samlas in i versionsmapparna (5.1, 7.0, 7.1 och 7.2). Det här innehållet innehåller endast cmdlet-referens för de moduler som levereras med PowerShell. Det här innehållet används också för att skapa hjälpinformationen som visas av cmdleten Get-Help .

Konceptuellt innehåll

Den konceptuella dokumentationen innehåller följande innehåll:

  • Viktig information
  • Installationsanvisningar
  • Exempelskript och instruktioner
  • DSC-dokumentation
  • SDK-dokumentation

Den konceptuella dokumentationen är inte ordnad efter version. Alla artiklar visas för varje version av PowerShell. Vi arbetar med att skapa versionsspecifika artiklar.

Anteckning

Varje gång en konceptuell artikel läggs till, tas bort eller byter namn måste toC uppdateras och inkluderas i pull-begäran.

Skapa nya artiklar

Ett GitHub problem måste skapas för alla nya dokument som du vill bidra med. Kontrollera om det finns befintliga problem för att se till att du inte duplicerar arbetet. Tilldelade problem anses vara in progress. Om du vill samarbeta i ett ärende kontaktar du den person som har tilldelats problemet.

På samma sätt som i PowerShell RFC-processen skapar du ett problem innan du skriver innehållet. Problemet säkerställer att du inte slösar tid och arbete som avvisas av PowerShell-Docs-teamet. Problemet gör att vi kan samråda med dig om innehållets omfattning och var det passar i PowerShell-dokumentationen. Alla artiklar måste inkluderas i innehållsförteckningen (TOC). Den föreslagna platsen för innehållsförteckningen bör ingå i diskussionsämnet.

Anteckning

Innehållsförteckningen för referensinnehåll genereras automatiskt av publiceringssystemet. Du behöver inte uppdatera toc-koden.

Uppdatera befintliga artiklar

I förekommande fall dupliceras cmdlet-referensartiklar i alla versioner av PowerShell som finns på den här lagringsplatsen. När du rapporterar ett problem om en cmdlet-referens eller en About_ artikel måste du ange vilka versioner som påverkas av problemet. Ärendemallen i GitHub innehåller en checklista med versioner. Använd kryssrutorna för att ange vilka versioner av innehållet som påverkas.

Kontrollera alla versioner av artikeln för att se om samma ändring krävs i de andra versionerna. Tillämpa lämplig ändring på varje version av filen.

Lokaliserat innehåll

PowerShell-dokumentationen är skriven på engelska och översatt till 17 andra språk. Det engelska innehållet lagras på den GitHub lagringsplatsen med namnet MicrosoftDocs/PowerShell-Docs. Det lokaliserade innehållet lagras på en separat lagringsplats för varje språk. Lagringsplatserna använder samma basnamn men lägger till språkvariantnamnet i slutet. Innehåller till exempel MicrosoftDocs/PowerShell-Docs.de-de det innehåll som översattes till tyska.

I allmänhet bör problem och ändringar skickas till den engelska lagringsplatsen. Alla översättningar börjar från det engelska innehållet först. Vi använder både mänsklig översättning och maskinöversättning.

Översättningsmetod Språk
Mänsklig översättning de-DE, es-ES, fr-FR, it-IT, ja-JP, ko-KR, pt-BR, ru-RU, zh-CN, zh-TW
Maskinöversättning cs-CZ, hu-HU, nl-NL, pl-PL, pt-PT, sv-SE, tr-TR

Innehållet som översätts av maskinöversättning kanske inte alltid resulterar i rätt ordval och grammatik. Om du hittar ett fel i översättningen för något språk, i stället för i den tekniska informationen i artikeln, öppnar du ett problem på den lokaliserade lagringsplatsen. Förklara varför du tror att översättningen är felaktig. Vårt lokaliseringsteam granskar och svarar på dessa problem.

Nästa steg

Det finns två vanliga sätt att skicka ändringar i GitHub. Båda metoderna beskrivs i den centrala deltagarguiden:

  1. Du kan göra snabba ändringar i befintliga dokument i GitHub webbgränssnittet.
  2. Använd det fullständiga GitHub arbetsflödet för att lägga till nya artiklar, uppdatera flera filer eller andra stora ändringar.

Innan du påbörjar ändringar bör du skapa en förgrening av PowerShell-Docs-lagringsplatsen. Ändringarna bör göras i en arbetsgren i din kopia av PowerShell-Docs. Om du använder snabbredigeringsmetoden i GitHub hanteras de här stegen åt dig. Om du använder det fullständiga GitHub arbetsflödet måste du konfigureras för att fungera lokalt.

Båda metoderna slutar med att en pull-begäran (PR) skapas. Mer information och metodtips finns i Skicka en pull-begäran .