PowerShell Cmdlet 可能很有用，但除非您的 [說明] 主題清楚說明 Cmdlet 的用途，以及如何使用它，否則 Cmdlet 可能無法使用，甚至更糟的是，它可能會讓使用者感到沮喪。 XML 型 Cmdlet 說明檔格式可增強一致性，但需要更多協助。
如果您從未撰寫過 Cmdlet 說明，請檢閱下列指導方針。 下一節將說明撰寫 Cmdlet 說明主題所需的 XML 架構。 從 建立 Cmdlet 說明檔開始。 該主題包含最上層 XML 節點的描述。
撰寫 Cmdlet 說明的指導方針
寫入良好
沒有什麼可取代撰寫良好的主題。 如果您不是專業作家，請尋找可協助您的作家或編輯。 另一個替代方法是將說明文字複製到 Microsoft Word，並使用文法和拼字檢查來改善您的工作。
直接撰寫
使用簡單的單字和片語。 避免用語。 請考慮許多讀者只配備外語字典和說明主題。
一致寫入
相關 Cmdlet 的說明應該類似 （例如，Get-Content 和 Set-Content）。 使用標準參數的標準描述，例如 Force 和 InputObject。 （從核心 Cmdlet 的說明複製它們。使用標準詞彙。 例如，使用 「parameter」、“not ”argument“，並使用 ”cmdlet“ 而非 ”command“ 或 ”command-let“。
使用動詞啟動摘要
Synopsis 字段會通知使用者 Cmdlet 的用途，而不是 Cmdlet 的功能或運作方式。 Verbs 會建立工作型語句，告知使用者此 Cmdlet 是否符合其需求。 使用簡單的動詞，例如 「get」、“create” 和 “change”。請避免 「set」，這可以是模糊且花哨的文字，例如 「modify」。。
將焦點放在物件上
大部分的 「get」Cmdlet 都會顯示某些專案，但其主要函式是取得物件。 在您的 [說明] 中，將焦點放在 物件上，讓使用者瞭解默認顯示是其中之一，而且他們可以使用您以不同方式為其擷取之物件的方法和屬性。
撰寫詳細描述
簡短列出 Cmdlet 可在詳細描述中執行的所有作業。 如果main函式是變更一個屬性，但 Cmdlet 可以變更所有屬性，請在詳細描述中列出此專案。
使用傳統語法
使用適用於 Windows 和 Unix 命令行說明的標準 Backus-Naur 格式。
針對參數值使用Microsoft .NET 類型
參數值的佔位元（在語法和參數描述中）會顯示參數將接受之物件的 .NET Framework 類型。 PowerShell 小組開發了此慣例，可協助教導用戶有關 .NET Framework 的資訊。
撰寫完整的參數描述
參數描述必須通知使用者兩件事：參數的作用（其效果），以及參數值必須輸入的內容。
撰寫實用範例
這些範例應該示範如何使用所有參數，但最重要的是示範如何在真實世界中使用 Cmdlet。 從簡單的範例開始，並撰寫越來越複雜的範例。 在最後一個範例中，示範如何在管線中使用 Cmdlet。
使用 [附注] 欄位
使用 [附註] 欄位來說明使用者需要瞭解 Cmdlet 的概念。 您也可以使用附注來協助使用者避免常見的錯誤。 避免 URL 在變更時發生。 相反地，請提供要搜尋的使用者字詞。
測試您的說明
就像測試程式代碼一樣，測試說明。 讓朋友和同事閱讀您的說明內容並提供意見反應。 您也可以向新聞群組徵求意見反應。
