开始为 PowerShell 文档做出贡献

本文概述了如何开始作为 PowerShell 文档的贡献者。

PowerShell-文档结构

PowerShell-Docs 存储库分为两组内容：参考内容和概念内容。

参考内容

参考内容是 PowerShell 中附带的 cmdlet 的 PowerShell cmdlet 参考。 cmdlet 参考收集在版本文件夹（如 5.1、7.0 和 7.2）中，其中包含 PowerShell 附带的模块的参考。此内容还用于创建 Get-Help cmdlet 显示的帮助信息。

概念内容

概念文档不按版本组织。显示每个版本的 PowerShell 的所有文章。

笔记

每当添加、删除或重命名概念性文章时，都必须更新目录，并且必须重定向删除或重命名的文件。

创建新文章

必须为您想要贡献的任何新文档创建 GitHub 问题。检查现有问题以确保您不会重复工作。分配的问题被视为正在进行中。如果您希望就某个问题进行协作，请联系分配给该问题的人员。

与 PowerShell RFC 流程类似，在编写内容之前创建问题。该问题可确保您不会在被 PowerShell-Docs 团队拒绝的工作上浪费时间和精力。该问题使我们能够就内容范围以及它在 PowerShell 文档中的适用位置与您进行协商。所有文章都必须包含在目录 (TOC) 中。建议的 TOC 位置应包含在问题讨论中。

笔记

参考内容的目录由发布系统自动生成。您不必更新目录。

更新现有文章

如果适用，cmdlet 参考文章会在此存储库中维护的所有 PowerShell 版本中重复。报告有关 cmdlet 引用或 About_ 文章的问题时，请列出存在问题的文章版本。

对文件的每个版本应用适当的更改。

本地化内容

PowerShell 文档以英语编写，并翻译成其他 17 种语言。英文内容存储在名为 MicrosoftDocs/PowerShell-Docs 的 GitHub 存储库中。翻译内容中发现的问题应提交至英文存储库。

所有翻译首先从英文内容开始。我们同时使用人工翻译和机器翻译。

de-DE、es-ES、fr-FR、it-IT、ja-JP、ko-KR、pt-BR、ru-RU、zh-CN、zh-TW

cs-CZ、hu-HU、nl-NL、pl-PL、pt-PT、sv-SE、tr-TR

机器翻译翻译的内容可能并不总是产生正确的单词选择和语法。如果您发现任何语言的翻译错误，而不是文章的技术细节错误，请提出一个问题，解释您认为翻译错误的原因。

一些翻译问题可以通过更改英文源文件来解决。但是，某些问题可能需要更新我们的内部翻译系统。对于这些情况，我们必须将问题提交给我们的内部本地化团队进行审查和响应。

后续步骤

在 GitHub 中提交更改有两种常见方法。中央贡献者指南中描述了这两种方法：

1. 您可以在 GitHub Web 界面中快速编辑现有文档。
2. 使用完整的 GitHub 工作流程添加新文章、更新多个文件或其他大型更改。

在开始任何更改之前，您应该创建 PowerShell-Docs 存储库的分支。应在 PowerShell 文档副本中的工作分支中进行更改。如果您在 GitHub 中使用快速编辑方法，系统会为您处理这些步骤。如果您使用完整的 GitHub 工作流程，则必须设置为在本地工作。

两种方法都以创建拉取请求 (PR) 结束。请参阅提交拉取请求以获取更多信息和最佳实践。