关于 GitHub 的文档基础知识

关于 文档需要这些基础知识。 使用以下列表来帮助确保你的贡献准确、易于访问、具有包容性并且一致。

准确

文档正确且准确。

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

确保内容易于访问且具有包容性。

文档符合最新的可访问性标准，并且编写时考虑到辅助功能和翻译友好性。

• 确保内容遵循辅助功能和屏幕截图指南。 有关详细信息，请参阅“创建屏幕截图”。
• 确保内容可以成功翻译。 有关详细信息，请参阅“编写要翻译的内容”。

一致

文档保持一致的语气、语调和风格，为读者创造连贯的阅读体验。

• 确保内容遵循 GitHub Docs 风格指南。 有关详细信息，请参阅“风格指南”。
• 应用一致的术语和命名约定。
• 在内容中一致地使用品牌元素（例如产品和功能名称、徽标、颜色方案）。