关于 GitHub 的内容设计原则
我们编写的产品文档旨在帮助、教导并吸引所有 GitHub 使用者。其中一步工作是设计我们所撰写的内容。我们在设计和规划内容时遵循这些原则。
- 我们的内容以用户为中心且包容性强。我们尊重每一位访问文档的用户，并通过我们的策略、设计和风格选择制作适合他们的内容。
- 我们的内容阐释产品为何有价值，并帮助人们实现其目标和优先事项。
- 我们投入资源，为 GitHub 社区创建高质量、有价值的文档。
- 我们只编写恰到好处的文档——内容过多会导致信息难以查找，任何额外添加都会稀释其他内容（GitHub Zen）。
- 我们通过迭代和发布来学习——随着从实践、行业专业知识以及与 GitHub 文档社区的合作中获得更多经验，我们会调整流程、做法和指南。
我们提供风格指南和内容模型，作为设计与创建文档的构建块和参考规范。
- 我们的风格指南与内容模型适用于多种情境。
- 决策基于对使用文档的人的最佳利益，而不仅仅是语法或风格规则的对错。我们保持灵活并乐于变更，同时保持一致性。
- 我们将注意力聚焦于记录高影响、高价值的场景，而不是试图全面覆盖所有 GitHub 产品和功能的每一种可能用例。
- 我们的首要任务是清晰、意义、正确和一致。
- 在做出风格或结构决策时，我们会考虑用户希望通过信息完成的任务，以及我们的内容如何最佳支持他们的目标。
- 当文档相关的问题未在风格指南或内容模型中得到覆盖时，我们会依据这些原则进行评估，然后作出决定。