Add rule documentations for all PS rules

Author: yutingc

RuleDocumentation/UseDeclaredVarsMoreThanAssignments.md

@@ -0,0 +1,31 @@
+#UseDeclaredVarsMoreThanAssignments 
+**Severity Level: Info**
+
+
+##Description
+
+Checks that variables are used in more than just their assignment. Generally this is a red flag that a variable is not needed. This rule does not check if the assignment and usage are in the same function.
+
+
+##How to Fix
+
+Please consider remove the variables that are declared but not used outside of the function.
+
+
+##Example
+Wrong： 
+    
+    function Test
+    {
+        $declaredVar = "Declared"
+        $declaredVar2 = "Not used"
+    }
+
+Correct: 
+
+    function Test
+    {
+        $declaredVar = "Declared just for fun"
+        Write-Output $declaredVar
+    }
+

RuleDocumentation/UsePSCredentialType.md

@@ -0,0 +1,27 @@
+#UsePSCredentialType
+**Severity Level: Warning**
+
+
+##Description
+
+Checks that cmdlets that have a Credential parameter accept PSCredential. This comes from the PowerShell teams best practices.
+
+##How to Fix
+
+Please change the parameter type to be PSCredential.
+
+##Example
+
+Wrong:
+
+	function Credential([string]$credential) 
+	{
+		...
+	}
+
+Correct:
+
+	function Credential([PSCredential]$credential) 
+	{
+		...
+	}

RuleDocumentation/UseShouldProcessCorrectly.md

@@ -0,0 +1,127 @@
+#UseShouldProcessCorrectly 
+**Severity Level: Error**
+
+
+##Description
+
+Checks that if the SupportsShouldProcess is present, the function calls ShouldProcess/ShouldContinue and vice versa. Scripts with one or the other but not both will generally run into an error or unexpected behavior.
+
+
+##How to Fix
+
+To fix a violation of this rule, please call ShouldProcess method in advanced functions when SupportsShouldProcess argument is present. Or please add SupportsShouldProcess argument when calling ShouldProcess.You can get more details by running “Get-Help about_Functions_CmdletBindingAttribute” and “Get-Help about_Functions_Advanced_Methods” command in Windows PowerShell.
+
+##Example
+
+Wrong： 
+
+	function Verb-Files
+	{
+	    [CmdletBinding(DefaultParameterSetName='Parameter Set 1', 
+	                  SupportsShouldProcess=$true, 
+	                  PositionalBinding=$false,
+	                  HelpUri = 'http://www.microsoft.com/',
+	                  ConfirmImpact='Medium')]
+	    [Alias()]
+	    [OutputType([String])]
+	    Param
+	    (
+	        # Param1 help description
+	        [Parameter(Mandatory=$true, 
+	                   ValueFromPipeline=$true,
+	                   ValueFromPipelineByPropertyName=$true, 
+	                   ValueFromRemainingArguments=$false, 
+	                   Position=0,
+	                   ParameterSetName='Parameter Set 1')]
+	        [ValidateNotNull()]
+	        [ValidateNotNullOrEmpty()]
+	        [ValidateCount(0,5)]
+	        [ValidateSet("sun", "moon", "earth")]
+	        [Alias("p1")] 
+	        $Param1,
+	        # Param2 help description
+	        [Parameter(ParameterSetName='Parameter Set 1')]
+	        [AllowNull()]
+	        [AllowEmptyCollection()]
+	        [AllowEmptyString()]
+	        [ValidateScript({$true})]
+	        [ValidateRange(0,5)]
+	        [int]
+	        $Verbose,
+	    )
+
+	    Begin
+	    {
+	    }
+	    Process
+	    {
+	    }
+	    End
+	    {
+	    }
+	}
+
+Correct:
+
+	function Get-File
+	{
+	    [CmdletBinding(DefaultParameterSetName='Parameter Set 1', 
+	                  SupportsShouldProcess=$true, 
+	                  PositionalBinding=$false,
+	                  HelpUri = 'http://www.microsoft.com/',
+	                  ConfirmImpact='Medium')]
+	    [Alias()]
+	    [OutputType([String])]
+	    Param
+	    (
+	        # Param1 help description
+	        [Parameter(Mandatory=$true, 
+	                   ValueFromPipeline=$true,
+	                   ValueFromPipelineByPropertyName=$true, 
+	                   ValueFromRemainingArguments=$false, 
+	                   Position=0,
+	                   ParameterSetName='Parameter Set 1')]
+	        [ValidateNotNull()]
+	        [ValidateNotNullOrEmpty()]
+	        [ValidateCount(0,5)]
+	        [ValidateSet("sun", "moon", "earth")]
+	        [Alias("p1")] 
+	        $Param1,
+
+	        # Param2 help description
+	        [Parameter(ParameterSetName='Parameter Set 1')]
+	        [AllowNull()]
+	        [AllowEmptyCollection()]
+	        [AllowEmptyString()]
+	        [ValidateScript({$true})]
+	        [ValidateRange(0,5)]
+	        [int]
+	        $Param2,
+
+	        # Param3 help description
+	        [Parameter(ParameterSetName='Another Parameter Set')]
+	        [ValidatePattern("[a-z]*")]
+	        [ValidateLength(0,15)]
+	        [String]
+	        $Param3,
+	        [bool]
+	        $Force
+	    )
+
+	    Begin
+	    {
+	    }
+	    Process
+	    {
+	        if ($pscmdlet.ShouldProcess("Target", "Operation"))
+	        {
+	            Write-Verbose "Write Verbose"
+	            Get-Process
+	        }
+	    }
+	    End
+	    {
+	        if ($pscmdlet.ShouldContinue("Yes", "No")) {
+	        }
+	    }
+	}

RuleDocumentation/UseSingularNouns.md

@@ -0,0 +1,26 @@
+#UseSingularNouns 
+**Severity Level: Warning**
+
+##Description
+
+Cmdlet should use singular instead of plural nouns. This comes from the PowerShell teams best practices.
+
+##How to Fix
+
+Please correct the plural nouns to be singluar.
+
+##Example
+
+Wrong：
+
+	function Get-Files
+	{
+		...
+	}
+
+Correct: 
+
+	function Get-File
+	{
+		...
+	}