11---
2- description : This is a summarized list of rules for editing PowerShell documentation.
3- ms.date : 11/16/2022
2+ description : This article contains a summarized list of rules for editing PowerShell documentation.
3+ ms.date : 03/30/2025
44title : Editorial checklist
55---
66# Editor's checklist
77
8- This is a summary of rules to apply when writing new or updating existing articles. See other
9- articles in the Contributor's Guide for detailed explanations and examples of these rules.
8+ This article contains a summarized list of rules for writing or editing PowerShell documentation.
9+ See other articles in the Contributor's Guide for detailed explanations and examples of these rules.
1010
1111## Metadata
1212
1313- ` ms.date ` : must be in the format ** MM/DD/YYYY**
14- - Change the date when there is a significant or factual update
14+ - Change the date when there's a significant or factual update
1515 - Reorganizing the article
1616 - Fixing factual errors
1717 - Adding new information
@@ -31,7 +31,7 @@ articles in the Contributor's Guide for detailed explanations and examples of th
3131 - File paths ` C:\Program Files\PowerShell ` , ` /usr/bin/pwsh `
3232 - URLs that aren't meant to be clickable in the document
3333 - Property or parameter values
34- - Use bold for property names, parameter names, class names, module names, entity names, object or
34+ - Use bold for property names, parameter names, class names, module names, entity names, object, or
3535 type names
3636 - Bold is used for semantic markup, not emphasis
3737 - Bold - use asterisks ` ** `
@@ -45,39 +45,39 @@ articles in the Contributor's Guide for detailed explanations and examples of th
4545
4646### Headers
4747
48- - H1 is first - only one H1 per article
48+ - Start with H1 first - only one H1 per article
4949- Use [ ATX Headers] [ 1 ] only
5050- Use sentence case for all headers
5151- Don't skip levels - no H3 without an H2
52- - Max depth of H3 or H4
53- - Blank line before and after
54- - PlatyPS enforces specific headers in its schema - don't add or remove headers
52+ - Limit header depth to H3 or H4
53+ - Add blank lines before and after
54+ - Don't add or remove headers - PlatyPS enforces specific headers in its schema
5555
5656### Code blocks
5757
58- - Blank line before and after
58+ - Add blank lines before and after
5959- Use tagged code fences - ** powershell** , ** Output** , or other appropriate language ID
60- - Untagged fence - syntax blocks or other shells
61- - Put output in separate code block except for basic examples where you don't intend the for the
60+ - Use untagged code fence for syntax blocks
61+ - Put output in separate code block except for basic examples where you don't intend for the
6262 reader to use the ** Copy** button
6363- See list of [ supported languages] [ 2 ]
6464
6565### Lists
6666
67- - Indented properly
68- - Blank line before first item and after last item
69- - Bullet - use hyphen (` - ` ) not asterisk (` * ` ) to reduce confusion with emphasis
70- - For numbered lists, all numbers are "1."
67+ - Indent properly
68+ - Add blank lines before first item and after last item
69+ - Use hyphen (` - ` ) for bullets not asterisk (` * ` ) to reduce confusion with emphasis
70+ - Use ` 1. ` for all items in a numbered list
7171
7272## Terminology
7373
74- - PowerShell vs. Windows PowerShell
74+ - Use _ PowerShell _ vs. _ Windows PowerShell _
7575- See [ Product Terminology] [ 3 ]
7676
7777## Cmdlet reference examples
7878
7979- Must have at least one example in cmdlet reference
80- - Examples should be just enough code to demonstrate the usage
80+ - Examples should be only enough code to demonstrate the usage
8181- PowerShell syntax
8282 - Use full names of cmdlets and parameters - no aliases
8383 - Use splatting for parameters when the command line gets too long
@@ -108,11 +108,12 @@ articles in the Contributor's Guide for detailed explanations and examples of th
108108## Linking to other documents
109109
110110- When linking outside the docset or between cmdlet reference and conceptual
111- - Use site-relative URLs when linking to Microsoft Learn (remove ` https://learn.microsoft.com/en-us ` )
112- - don't include locales in URLs on Microsoft properties (eg. remove ` /en-us ` from URL)
111+ - Use site-relative URLs when linking to Microsoft Learn (remove
112+ ` https://learn.microsoft.com/en-us ` )
113+ - don't include locales in URLs on Microsoft properties (remove ` /en-us ` from URL)
113114 - All URLs to external websites should use HTTPS unless that's not valid for the target site
114115- When linking within the docset
115- - Use the relative filepath (e.g. ` ../folder/file.md ` )
116+ - Use the relative filepath (` ../folder/file.md ` )
116117- All paths use forward-slash (` / ` ) characters
117118- Image links should have unique alt text
118119
0 commit comments