diff --git a/.github/instructions/reference-doc.instructions.md b/.github/instructions/reference-doc.instructions.md new file mode 100644 index 000000000000..ba0b37d7d17e --- /dev/null +++ b/.github/instructions/reference-doc.instructions.md @@ -0,0 +1,9 @@ +--- +applyTo: "**/help/*.md" +--- + +## Reference help documentation requirements + +When writing reference documents for PowerShell cmdlets, please follow these guidelines to ensure readability and helpfulness: + +1. **Avoid over-simplified description** - For parameters and cmdlets, avoid over-simplified description such as "Some help", or simply repeating the parameter name.