关于 GitHub 的内容设计原则
我们创建的产品文档可以帮助、指导和吸引所有使用 GitHub 的人。这项工作的一步是设计我们撰写的内容。我们在设计和规划内容时遵循这些原则。
- 我们的内容以用户为中心，并具有包容性。我们尊重访问文档的每一个人，并通过我们的策略、设计和风格选择，为他们提供有效的内容。
- 我们的内容解释了我们的产品为何有用，并帮助人们实现他们的目标和优先事项。
- 我们投入资源为 GitHub 社区创建高质量、有价值的文档。
- 我们只创建必要的文档 - 更多内容会让所有内容更难找到，添加任何内容都会稀释其他内容（GitHub 禅宗）。
- 我们迭代并发布以学习 - 随着我们从经验、行业专业知识和与 GitHub 文档社区合作中获得更多知识，我们调整我们的流程、实践和指南。
我们提供风格指南和内容模型作为构建块和指南，供任何人设计和创建文档。
- 我们的风格指南和内容模型适用于各种场景。
- 决策基于对使用我们文档的人来说最好的选择，而不是仅仅根据语法或风格规则判断对错。我们灵活且乐于改变，同时保持一致性。
- 我们专注于记录高影响力、高价值的场景，而不是试图全面涵盖 GitHub 众多产品和功能的每种可能用例。
- 我们的最高优先级是清晰度、意义、正确性和一致性。
- 在做出风格或结构决策时，我们会考虑人们试图用这些信息做什么，以及我们的内容如何才能最好地支持他们的目标。
- 当风格指南或内容模型没有涵盖特定于文档的问题时，我们会使用这些原则对其进行评估，然后做出决定。