Feedback

Redigerarens checklista

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

Det här är en sammanfattning av regler som ska tillämpas när du skriver nya eller uppdaterar befintliga artiklar. Se andra artiklar i deltagarguiden för detaljerade förklaringar och exempel på dessa regler.

Metadata

  • ms.date: måste ha formatet MM/DD/YYYY
    • Ändra datumet när det finns en betydande eller faktisk uppdatering
      • Organisera om artikeln
      • Åtgärda faktiska fel
      • Lägga till ny information
    • Ändra inte datumet om uppdateringen är löst
      • Åtgärda stavfel och formatering
  • title: unik sträng med 43–59 tecken inklusive blanksteg
    • Ta inte med platsidentifierare (den genereras automatiskt)
    • Använd meningsfall – använd endast det första ordet och eventuella lämpliga substantiv med versaler
  • description: 115–145 tecken inklusive blanksteg – den här abstraktionen visas i sökresultatet

Formatering

  • Bakåtklicka på syntaxelement som visas, infogade, i ett stycke
    • Cmdlet-namn Verb-Noun
    • Variabel $counter
    • Syntaktiska exempel Verb-Noun -Parameter
    • Filsökvägar C:\Program Files\PowerShell , /usr/bin/pwsh
    • Webbadresser som inte är avsedda att vara klickbara i dokumentet
    • Egenskaps- eller parametervärden
  • Använd fetstil för egenskapsnamn, parameternamn, klassnamn, modulnamn, entitetsnamn, objekt- eller typnamn
    • Fetstil används för semantisk markering, inte betoning
    • Fetstil – använd asterisker **
  • Kursiv – använd understreck _
    • Används endast för betoning, inte för semantisk markering
  • Radbrytningar vid 100 kolumner (eller vid 80 för about_Topics)
  • Inga hårda flikar – använd endast blanksteg
  • Inga avslutande blanksteg på rader
  • PowerShell-nyckelord och operatorer ska endast vara gemener
  • Använd rätt (Pascal) hölje för cmdlet-namn och parametrar

Sidhuvuden

  • H1 är först – endast en H1 per artikel
  • Använd endast ATX-huvuden
  • Använd meningsfall för alla rubriker
  • Hoppa inte över nivåer – ingen H3 utan H2
  • Maximalt djup för H3 eller H4
  • Tom rad före och efter
  • PlatyPS tillämpar specifika huvuden i sitt schema – lägg inte till eller ta bort rubriker

Kodblock

  • Tom rad före och efter
  • Använda taggade kodstängsel – powershell, utdata eller annat lämpligt språk-ID
  • Ej taggad stängsel – syntaxblock eller andra gränssnitt
  • Placera utdata i separata kodblock förutom för enkla exempel där du inte avser att läsaren ska använda knappen Kopiera
  • Se listan över språk som stöds

Listor

  • Korrekt indrag
  • Tom rad före det första objektet och efter det sista objektet
  • Bullet – använd bindestreck ( - ) inte asterisk ( ) – för lätt att förväxla med * betoning
  • För numrerade listor är alla tal "1".

Terminologi

  • PowerShell jämfört med Windows PowerShell jämfört med PowerShell Core
  • Se Produktterminologi

Cmdlet-referensexempel

  • Måste ha minst ett exempel i cmdlet-referens

  • Exemplen bör vara tillräckligt med kod för att demonstrera användningen

  • PowerShell-syntax

    • Använd fullständiga namn på cmdlets och parametrar – inga alias
    • Använd splatting för parametrar när kommandoraden blir för lång
    • Undvik att använda rad fortsättningsbackticks – använd endast när det behövs

  • Ta bort eller förenkla PowerShell-prompten ( PS> ) förutom där det krävs för exemplet

  • Cmdlet-referensexempel måste följa följande PlatyPS-schema

    ### 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.

  • Placera inte stycken mellan kodblocken. Allt beskrivande innehåll måste komma före eller efter kodblocken.

Länka till andra dokument

  • Länka utanför dokumentuppsättningen eller mellan cmdlet-referens och konceptuell
    • Använd relativa URL:er när du länkar till docs.microsoft.com (ta bort https://docs.microsoft.com/en-us )
    • Ta inte med språk i URL:er i Microsoft-egenskaper (t.ex. ta /en-us bort från URL))
    • Alla webbadresser till externa webbplatser ska använda HTTPS om inte detta inte är giltigt för målplatsen
  • Inom dokumentuppsättningen
    • Länk till filsökväg (t.ex. ../folder/file.md )
    • Alla sökvägar använder snedstreck ( / ) tecken
  • Bildlänkar ska ha unik alternativtext