参与完善 GitHub Docs 文档

了解 GitHub Docs 团队如何创建文档以及你能如何参与文档的编写。

概述 快速入门

建议

关于贡献 GitHub 文档

可以通过多种方式参与 GitHub Docs 内容的编写。

GitHub Docs 的最佳实践

按照这些最佳做法即可创建用户友好且易于理解的文档。

风格指南

按照本指南操作，确保 GitHub 的文档保持一致，并遵循读者可以理解的明确规律。

文章

Follow the style guide and content model

GitHub Docs 文章的内容

每篇文章都包含一些标准元素，并且可能包含条件元素或可选元素。 我们还对文章中的内容使用标准顺序。
Understand the GitHub approach to docs

GitHub Docs 的最佳实践

按照这些最佳做法即可创建用户友好且易于理解的文档。
Write and format content

为 GitHub Docs 创建关系图

本指南介绍何时与如何为 GitHub Docs 创建关系图。
Get set up to contribute

使用 TODOCS 占位符留下注释

可以使用 TODOCS 占位符来指示仍需要完成的工作。
Write and format content

使用 YAML 前辅文

可以使用 YAML 前辅文来定义版本控制、添加元数据和控制文章的布局。
Get set up to contribute

使用内容校验工具

可以使用内容 Linter 检查你贡献的内容是否存在任何错误。
Understand the GitHub approach to docs

关于 GitHub 的文档基础知识

在 GitHub Docs 上发布的所有内容必须满足这些基本要求。
Understand the GitHub approach to docs

关于 GitHub 的文档理念

我们的文档理念指导我们创建的内容以及创建内容的方式。
Follow the style guide and content model

关于内容模型

内容模型描述我们发布的内容的结构和类型。
显示 37 的 1-9