Controlelijst voor editor

Dit is een samenvatting van de regels die moeten worden toegepast bij het schrijven van nieuwe artikelen of het bijwerken van bestaande artikelen. Zie andere artikelen in de gids voor inzenders voor gedetailleerde uitleg en voorbeelden van deze regels.

Metagegevens

• ms.date: moet de notatie MM/DD/YYYY hebben
  • De datum wijzigen waarop een belangrijke of feitelijke update is
    • Het artikel opnieuw indelen
    • Feitelijke fouten oplossen
    • Nieuwe informatie toevoegen
  • Wijzig de datum niet als de update niet op de hoogte is
    • Typfouten en opmaak herstellen
• title: unieke tekenreeks van 43-59 tekenreeksen, inclusief spaties
  • Neem geen site-id op (deze wordt automatisch gegenereerd)
  • Gebruik een zinscase: alleen het eerste woord en de juiste zelfstandige naamwoorden in hoofdletters gebruiken
• description: 115-145 tekens, inclusief spaties. Dit abstracte wordt weergegeven in het zoekresultaat

Opmaak

• Backtick-syntaxiselementen die inline in een alinea worden weergegeven
  • Cmdlet-namen Verb-Noun
  • Variabele $counter
  • Syntactische voorbeelden Verb-Noun -Parameter
  • Bestandspaden C:\Program Files\PowerShell , /usr/bin/pwsh
  • URL's die niet zijn bedoeld om in het document te klikken
  • Eigenschaps- of parameterwaarden
• Gebruik vet voor eigenschapsnamen, parameternamen, klassenamen, modulenamen, entiteitsnamen, object- of typenamen
  • Vet wordt gebruikt voor semantische markering, niet voor nadruk
  • Vet : sterretjes gebruiken **
• Italic - onderstrepingsteken gebruiken _
  • Alleen gebruikt voor nadruk, niet voor semantische markeringen
• Regelbreaks bij 100 kolommen (of op 80 voor about_Topics)
• Geen harde tabbladen: alleen spaties gebruiken
• Geen spaties volgen op regels
• PowerShell-trefwoorden en -operators moeten allemaal kleine letters zijn
• Gebruik de juiste casing (Pascal) voor cmdlet-namen en -parameters

Kopteksten

• H1 is de eerste: slechts één H1 per artikel
• Alleen ATX-headers gebruiken
• Gebruik een zinscase voor alle headers
• Niveaus niet overslaan- geen H3 zonder H2
• Maximale diepte van H3 of H4
• Lege regel vóór en na
• PlatyPS dwingt specifieke headers af in het schema - voeg geen headers toe of verwijder ze niet

Codeblokken

• Lege regel vóór en na
• Gelabelde codeomheiningen gebruiken - powershell, uitvoer of andere geschikte taal-id
• Fence zondertagged - syntaxisblokken of andere shells
• Plaats uitvoer in een afzonderlijk codeblok, met uitzondering van eenvoudige voorbeelden waarbij u niet van plan bent om de lezer de knop Kopiëren te laten gebruiken
• Lijst met ondersteunde talen bekijken

Lijsten

• Goed ingesprongen
• Lege regel vóór eerste item en na laatste item
• Opsommingsteken - gebruik afbreekstreester ( - ) niet asterisk ( ) - te gemakkelijk * te verwarrend met nadruk
• Voor genummerde lijsten zijn alle getallen '1'.

Terminologie

• PowerShell versus Windows PowerShell vs. PowerShell Core
• Zie Productterminologie

Voorbeelden van cmdlet-verwijzingen

• Moet ten minste één voorbeeld hebben in cmdlet-verwijzing

• Voorbeelden moeten net voldoende code zijn om het gebruik te demonstreren

• PowerShell-syntaxis

  • Volledige namen van cmdlets en parameters gebruiken - geen aliassen
  • Gebruik splatting voor parameters wanneer de opdrachtregel te lang wordt
  • Vermijd het gebruik van regel vervolgbackticks- alleen gebruiken wanneer dat nodig is

• Verwijder of vereenvoudig de PowerShell-prompt ( PS> ), behalve waar vereist voor het voorbeeld

• Voorbeeld van cmdlet-verwijzing moet het volgende PlatyPS-schema volgen

  ### Example 1 - Descriptive title
  
  Zero or more short descriptive paragraphs explaining the context of the example followed by one or
  more code blocks. Recommend at least one and no more than two.
  
  ```powershell
  ... one or more PowerShell code statements ...
  ```
  
  ```Output
  Example output of the code above.
  ```
  
  Zero or more optional follow up paragraphs that explain the details of the code and output.
  

• Plaats geen alinea's tussen de codeblokken. Alle beschrijvende inhoud moet vóór of na de codeblokken komen.

Koppelen aan andere documenten

• Koppelen buiten de docset of tussen cmdlet-verwijzing en conceptueel
  • Relatieve URL's gebruiken bij het koppelen aan docs.microsoft.com (verwijderen https://docs.microsoft.com/en-us )
  • Not include locales in URL's on Microsoft properties (bijvoorbeeld verwijderen /en-us uit URL)
  • Alle URL's naar externe websites moeten HTTPS gebruiken, tenzij dat niet geldig is voor de doelsite
• Binnen docset
  • Koppeling naar bestandspad (bijvoorbeeld ../folder/file.md )
  • Alle bestandspaden gebruiken tekens met een slash / ()
• Afbeeldingskoppelingen moeten unieke alternatieve tekst bevatten