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