关于 GitHub 文档基础

关于 GitHub 文档基础

这些基础要求适用于 GitHub 文档。请使用以下列表帮助确保您的贡献准确、可访问且包容，并保持一致。

准确

文档是正确且准确的。

• 确保内容没有事实错误。
• 确保内容没有拼写和格式错误。

可访问且包容

文档符合最新的可访问性标准，且编写时考虑包容性和易于翻译。

• 确保内容符合可访问性和截图指南。更多信息，请参阅 创建截图。
• 确保内容能够成功翻译。更多信息，请参阅 编写可翻译内容。

一致性

文档在整个过程中保持一致的语调、口吻和风格，为读者营造一致的阅读体验。

• 确保内容符合 GitHub Docs 样式指南。更多信息，请参阅 样式指南。
• 使用一致的术语和命名约定。
• 在内容中一致使用品牌元素（例如产品和功能名称、徽标、配色方案）。