{"meta":{"title":"关于 GitHub 的文档基础知识","intro":"在 GitHub Docs 上发布的所有内容必须满足这些基本要求。","product":"贡献 GitHub 文档","breadcrumbs":[{"href":"/zh/contributing","title":"贡献 GitHub 文档"},{"href":"/zh/contributing/writing-for-github-docs","title":"为 GitHub 文档撰写内容"},{"href":"/zh/contributing/writing-for-github-docs/about-githubs-documentation-fundamentals","title":"文档基础"}],"documentType":"article"},"body":"# 关于 GitHub 的文档基础知识\n\n在 GitHub Docs 上发布的所有内容必须满足这些基本要求。\n\n## 关于 GitHub 的文档基础知识\n\nGitHub 文档需要这些基本要素。 使用以下列表来帮助确保你的贡献准确、易于访问、具有包容性并且一致。\n\n## 准确\n\n文档正确且准确。\n\n* 确保内容没有事实错误。\n* 确保内容没有拼写和格式错误。\n\n## 确保信息易于访问并且具有包容性。\n\n文档符合最新的可访问性标准，并且编写时考虑到辅助功能和翻译友好性。\n\n* 确保内容遵循辅助功能和屏幕截图指南。 有关详细信息，请参阅“[创建屏幕截图](/zh/contributing/writing-for-github-docs/creating-screenshots)”。\n* 确保内容可以成功翻译。 有关详细信息，请参阅“[编写要翻译的内容](/zh/contributing/writing-for-github-docs/writing-content-to-be-translated)”。\n\n## 一致\n\n文档保持一致的语气、语调和风格，为读者创造连贯的阅读体验。\n\n* 确保内容遵循 GitHub Docs 风格指南。 有关详细信息，请参阅“[风格指南](/zh/contributing/style-guide-and-content-model/style-guide)”。\n* 应用一致的术语和命名约定。\n* 在内容中一致地使用品牌元素（例如产品和功能名称、徽标、颜色方案）。"}