编写针对 PowerShell Cmdlet 的帮助
PowerShell cmdlet 可能很有用，但除非你的帮助主题清楚地解释了 cmdlet 的作用以及如何使用它，否则 cmdlet 可能不会被使用，甚至更糟的是，它可能会使用户感到沮丧。 基于 XML 的 cmdlet 帮助文件格式增强了一致性，但很好的帮助需要更多。
如果从未编写 cmdlet 帮助，请查看以下准则。 以下部分介绍了创作 cmdlet 帮助主题所需的 XML 架构。 首先 创建 cmdlet 帮助文件。 本主题包含顶级 XML 节点的说明。
Cmdlet 帮助的编写指南
写好
没有任何内容取代了编写良好的主题。 如果你不是专业作家，请找到一位作家或编辑器来帮助你。 另一种替代方法是将帮助文本复制到 Microsoft Word，并使用语法和拼写检查来改进工作。
只需编写
使用简单的字词和短语。 避免行话。 请考虑许多读者仅配备外语词典和帮助主题。
一致写入
相关 cmdlet 的帮助应类似（例如，Get-Content 和 Set-Content）。 使用标准参数的标准说明，例如 Force 和 InputObject。 （从核心 cmdlet 的帮助复制它们。使用标准术语。 例如，使用“parameter”，而不是“argument”，并使用“cmdlet”而不是“command-let”。
使用谓词启动概要
Synopsis 字段告知用户 cmdlet 的作用，而不是 cmdlet 的作用或工作原理。 谓词创建基于任务的语句，告知用户此 cmdlet 是否满足其要求。 使用简单的谓词，如“get”、“create”和“change”。避免“set”，这可能是模糊和花哨的单词，如“modify”。
关注对象
大多数“get”cmdlet 显示某些内容，但其主要函数是获取对象。 在“帮助”中，专注于对象，以便用户了解默认显示是其中之一，并且他们可以使用你以不同方式为对象检索到的对象的方法和属性。
编写详细说明
简要列出 cmdlet 可以在详细说明中执行的所有作。 如果主函数是更改一个属性，但 cmdlet 可以更改所有属性，请列出详细说明中的此项。
使用传统语法
使用 Windows 和 Unix 命令行帮助通用的标准 Backus-Naur 格式。
对参数值使用 Microsoft .NET 类型
参数值的占位符（在语法和参数说明中）显示参数将接受的对象 .NET Framework 类型。 PowerShell 团队开发了此约定，以帮助向用户介绍 .NET Framework。
编写完整的参数说明
参数说明必须通知用户两件事：参数的作用（其效果），以及参数值必须键入的内容。
编写实用示例
这些示例应演示如何使用所有参数，但最重要的是演示如何在实际任务中使用 cmdlet。 从一个简单的示例开始，编写越来越复杂的示例。 在最后一个示例中，演示如何在管道中使用 cmdlet。
使用“备注”字段
使用“说明”字段来说明用户需要了解 cmdlet 的概念。 还可以使用笔记来帮助用户避免常见错误。 避免 URL 在更改时出现。 而是向用户提供搜索的字词。
测试帮助
像测试代码一样测试帮助。 让朋友和同事阅读帮助内容并提供反馈。 还可以从新闻组征求反馈。
