Updates van onze PowerShell-documentatie

Deze blogpost is geschreven door Jeff Sandquist, General Manager van het Azure Growth and Ecosystem-team.

Vandaag hebben we onze vernieuwde Azure PowerShell-ervaring voor docs.microsoft.com gelanceerd. Verbeteringen omvatten onder andere versiebeheer van modules, markering van codesyntax, inhoudsopgaves die eenvoudiger zijn te gebruiken en de mogelijkheid om documenten te bewerken en te verbeteren. Uit feedback van klanten bleek dat PowerShell-inhoud aan verbetering toe was. Hiermee hebben we de volgende stap gezet naar algehele verbetering van de kwaliteit van documentatie. We zijn begonnen met Azure, maar gaan in de komende maanden alle PowerShell-documentatie verplaatsen naar het nieuwe platform.

Uniforme referentiedocumenten voor PowerShell-modules

Het doel van onze referentiedocumenten voor PowerShell-modules is een uniforme ervaring te bieden voor alle PowerShell-modules die worden uitgebracht door Microsoft. Dit omvat:

• Consistente URL-patronen: als u de naam van de module of cmdlet weet, weet u ook de URL. Dit is het URL-patroon dat in Docs wordt gebruikt: docs.microsoft.com/powershell/module/{module-name}/{cmdlet-name}/. Voor de cmdlet Get-AzureRMStorageAccount in de module AzureRM.Storage is de URL: https://docs.microsoft.com/powershell/module/azurerm.storage/get-azurermstorageaccount.
• Consistente gebruikerservaring: de opmaak van modules, cmdlets en voorbeelden is nu in alle PowerShell-documenten hetzelfde.
• Eenvoudig bijdragen: PowerShell-gebruikers kunnen codevoorbeelden in referentiedocumenten rechtstreeks op de documentatiepagina toevoegen of bewerken via de knop Bewerken.
• Ondersteuning voor versiebeheer voor oudere versies van PowerShell: gebruik onze versiekiezer op de pagina om te filteren op een specifieke versie van Azure PowerShell.

Versiebeheer in PowerShell

We hebben eerder gesproken over versiebeheer voor een specifieke module, maar aan sommige modules is een groep modules gekoppeld, elk met een eigen versiebeheerschema. Klanten downloaden Azure PowerShell bijvoorbeeld via PowerShellGet. Vroeger moesten klanten handmatig bepalen welke versies van de documenten van toepassing waren op hun installatie. Als u bijvoorbeeld Azure PowerShell 3.7 had geïnstalleerd, moest u elke afzonderlijke module kennen die daaraan was gekoppeld (AzureRM 3.7 was gekoppeld aan AzureRM.Automation 2.7 en AzureRM.CognitiveServices v0.5.0) en die documenten raadplegen.

Op het nieuwe documentatieplatform hoeft u slechts één versie te kiezen. Wij filteren dan op de juiste modules op basis van uw installatie.

Verbeterde inhoudsopgave

Naast verwijzingen naar cmdlets hebben we overzichten, installatiestappen, praktijkoefeningen en voorbeelden toegevoegd. In de naslaginformatie voor Azure hebben we cmdlets ook gegroepeerd op basis van Azure Service.

Eenvoudig filteren tijdens het typen in de inhoudsopgave

U kunt in de inhoudsopgave aan de linkerkant terwijl u typt eenvoudig filteren op overeenkomende cmdlets of services.

Verbeteringen op cmdlet-pagina's

Verbeterde inkleuring en indeling

PowerShell-cmdlets zijn nu voorzien van kleuren en andere opmaak om de leesbaarheid te verbeteren.

Parameterverbeteringen

De parameterlijst werd eerst ongeordend weergegeven, omdat parameters werden gegroepeerd, of ze nu vereist waren of optioneel. Nu hebben we sectiekoppen toegevoegd om vereiste en optionele parameters te groeperen. Ook hebben we de kleuren en stijl van parameternamen verbeterd.

Slimmer kopieer- en plakgedrag

Een aantal van de codevoorbeelden voor PowerShell-cmdlets wordt voorafgegaan door de tekst PS C:\>. Als u klikt op de knop Kopiëren voor het codevoorbeeld, kopiëren we het gedeelte PS C:\> niet meer mee, zoals te zien is op de Notepad-schermafbeelding hieronder.

Uw feedback

We hopen dat we uw gebruikerservaring met deze versie aanzienlijk verbeteren.