Szerkesztő ellenőrzőlistája

  • Cikk

Ez az új cikkek írásakor vagy meglévő frissítésekor alkalmazandó szabályok összegzése. A szabályok részletes magyarázatát és példáit a Közreműködői útmutató többi cikkében is talál.

Metaadatok

  • ms.date: HH/DD/YYYY formátumban kell lennie
    • Jelentős vagy tényleges frissítés dátumának módosítása
      • A cikk átrendeződése
      • A tényleges hibák kijavítása
      • Új információk hozzáadása
    • Ne változtassa meg a dátumot, ha a frissítés elavult
      • Az el hibák és a formázás kijavítva
  • title: 43–59 karakterből (szóközöket is beleértve) egyedi sztring
    • Ne foglalja bele a helyazonosítót (automatikusan létrejön)
    • Mondatok kis- és nagybetűinek használata – csak az első szó és a megfelelő főnevek nagybetűinek használata
  • description: 115–145 karakter, szóközöket is beleértve – ez az absztrakt karakter jelenik meg a keresési eredményben

Formátum

  • Bekezdésen belül megjelenő backtick szintaxiselemek
    • Parancsmagok nevei Verb-Noun
    • Változó $counter
    • Szintaktikai példák Verb-Noun -Parameter
    • Fájl elérési C:\Program Files\PowerShell útjai, /usr/bin/pwsh
    • Olyan URL-címek, amelyek nem kattinthatók a dokumentumban
    • Tulajdonság- vagy paraméterértékek
  • A félkövérrel szedett tulajdonságneveket, paraméterneveket, osztályneveket, modulneveket, entitásneveket, objektum- vagy típusneveket használja
    • A félkövér a szemantikai jelölőt használja, nem a kiemelést
    • Félkövér – csillagokat használjon **
  • Dőlt – aláhúzásjel használata _
    • Csak kiemelésre használatos, szemantikai jelölőre nem
  • Sortörések 100 oszlopnál (vagy 80-asnál a about_Topics)
  • Nincsenek tabulátorok – csak szóközöket használjon
  • Nincsenek záró szóközök a vonalakon
  • A PowerShell-kulcsszavaknak és -operátoroknak csak kisbetűkből kell álla
  • A parancsmagok neveihez és paramétereihez használja a megfelelő (Casc)-t

Fejlécek

  • A H1 az első – cikkenként csak egy H1
  • Csak ATX-fejlécek használata
  • Mondateset használata minden fejléchez
  • Ne hagyja ki a szinteket – H3 nincs H2 nélkül
  • H3 vagy H4 maximális mélysége
  • Üres sor előtte és utána
  • A PlatyPS a sémában meghatározott fejléceket kényszerít ki – ne adjon hozzá és ne távolítson el fejléceket

Kódblokkok

  • Üres sor előtte és utána
  • Címkézett kódkerítések használata – powershell, output, vagy egyéb megfelelő nyelvi azonosító
  • Nem megjelölt kerítés – szintaxisblokkok vagy egyéb rendszerhéjak
  • A kimenetet külön kódblokkba helyezze, kivéve azokat az egyszerű példákat, amelyekben nem szeretné, hogy az olvasó a Másolás gombot használja
  • A támogatott nyelvek listájának lásd:

Listák

  • Megfelelően behúzott
  • Üres sor az első elem előtt és az utolsó elem után
  • Bullet - use kötőjel ( - ) not asterisk ( ) - * too easy to confuse with emphasis
  • Számos listákhoz minden szám "1".

Terminológia

Példák parancsmagok használatára

  • Legalább egy példának kell lennie a parancsmag-referenciában

  • A példáknak elegendő kódnak kell lennie a használat szemléltető példáihoz

  • PowerShell-szintaxis

    • Parancsmagok és paraméterek teljes nevének használata – aliasok nélkül
    • Paraméterparaméterek használata, ha a parancssor túl hosszú
    • Kerülje a sor folytatási háttetűk használatát – csak szükség esetén használja

  • Távolítsa el vagy egyszerűsítse le a PowerShell-parancssort ( ), kivéve, ha PS> a példához szükséges

  • A parancsmag-referencia példának a következő PlatyPS sémát kell követnie

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

  • Ne helyezzen bekezdéseket a kódblokkok közé. Minden leíró tartalomnak a kódblokkok előtt vagy után kell lennie.

Hivatkozás más dokumentumokra

  • Hivatkozás a docseten kívül vagy a parancsmagok referenciája és fogalmi összefüggése között
    • Relatív URL-címek használata a kapcsolathoz való docs.microsoft.com https://docs.microsoft.com/en-us (eltávolítás)
    • A Microsoft tulajdonságainak URL-címében (például: eltávolítás /en-us AZ URL-címből)
    • A külső webhelyek összes URL-címének HTTPS-t kell használnia, kivéve, ha az nem érvényes a célhelyre
  • A dokumentumokon belül
    • Hivatkozás a fájl elérési útjára (pl. ../folder/file.md )
    • Minden fájl elérési útja perjelet ( / ) használ
  • A képhivatkozások helyettesítő szövegének egyedinek kell lennie