1
1
---
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
4
4
title : Editorial checklist
5
5
---
6
6
# Editor's checklist
7
7
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.
10
10
11
11
## Metadata
12
12
13
13
- ` 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
15
15
- Reorganizing the article
16
16
- Fixing factual errors
17
17
- Adding new information
@@ -31,7 +31,7 @@ articles in the Contributor's Guide for detailed explanations and examples of th
31
31
- File paths ` C:\Program Files\PowerShell ` , ` /usr/bin/pwsh `
32
32
- URLs that aren't meant to be clickable in the document
33
33
- 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
35
35
type names
36
36
- Bold is used for semantic markup, not emphasis
37
37
- Bold - use asterisks ` ** `
@@ -45,39 +45,39 @@ articles in the Contributor's Guide for detailed explanations and examples of th
45
45
46
46
### Headers
47
47
48
- - H1 is first - only one H1 per article
48
+ - Start with H1 first - only one H1 per article
49
49
- Use [ ATX Headers] [ 1 ] only
50
50
- Use sentence case for all headers
51
51
- 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
55
55
56
56
### Code blocks
57
57
58
- - Blank line before and after
58
+ - Add blank lines before and after
59
59
- 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
62
62
reader to use the ** Copy** button
63
63
- See list of [ supported languages] [ 2 ]
64
64
65
65
### Lists
66
66
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
71
71
72
72
## Terminology
73
73
74
- - PowerShell vs. Windows PowerShell
74
+ - Use _ PowerShell _ vs. _ Windows PowerShell _
75
75
- See [ Product Terminology] [ 3 ]
76
76
77
77
## Cmdlet reference examples
78
78
79
79
- 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
81
81
- PowerShell syntax
82
82
- Use full names of cmdlets and parameters - no aliases
83
83
- 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
108
108
## Linking to other documents
109
109
110
110
- 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)
113
114
- All URLs to external websites should use HTTPS unless that's not valid for the target site
114
115
- When linking within the docset
115
- - Use the relative filepath (e.g. ` ../folder/file.md ` )
116
+ - Use the relative filepath (` ../folder/file.md ` )
116
117
- All paths use forward-slash (` / ` ) characters
117
118
- Image links should have unique alt text
118
119
0 commit comments