关于 GitHub 的内容设计原则
我们创建产品文档，帮助、教授和吸引每个使用 GitHub 的人。 这项工作的一个步骤是设计我们编写的内容。 在设计和规划内容时，我们遵循这些原则。
- 我们的内容以用户为中心，具有包容性。 我们尊重每个访问文档的人，并通过我们的策略、设计和风格选择制作适合他们的内容。
- 我们的内容解释了为什么我们的产品有用，并帮助人员实现他们的目标和优先事项。
- 我们将资源用于为 GitHub 的社区创建高质量、有价值的文档。
- 我们只创建足够的文档 - 更多的内容会使所有内容更难找到，任何添加的内容都会稀释所有其他内容 (GitHub Zen)。
- 我们不断迭代，不断学习 - 随着我们从体验、行业专业知识以及与 GitHub Docs 社区的合作中学到更多，我们调整了我们的流程、做法和准则。
我们提供样式指南和内容模型作为构建基块和准则，供任何人设计和创建文档。
- 我们的样式指南和内容模型适用于一系列场景。
- 决策的基础是对使用我们文档的人员最有利的内容，而不仅仅是根据语法或样式规则的对错。 我们并非一成不变，愿意进行合理的更改，同时保持一致性。
- 我们专注于记录高影响力、高价值场景，而不是尝试全面涵盖许多 GitHub 产品和功能的每一种可能的用例。
- 我们最优先考虑的是明确、有意义、正确和一致。
- 在做出样式或结构决策时，我们会考虑人员尝试使用这些信息执行什么操作，以及我们的内容如何才能最好地支持他们的目标。
- 当样式指南或内容模型未涵盖特定于文档的问题时，我们将使用这些原则对其进行评估，然后做出决定。