> For the complete documentation index, see [llms.txt](https://github.highlight.ink/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://github.highlight.ink/documenting-projects/intro.md).

# 简介

> *译自* [*Documenting your projects on GitHub*](https://guides.github.com/features/wikis/)

良好的文档是任何项目成功的关键。使文档可访问让人们能够了解项目；使更新变得容易以确保文档贴近项目。

项目文档的两种常用组织方法是 \_README 文件\_和 *wikis*：

* README 文件是其他用户更快速，更简单地了解你的工作的方法。
* GitHub 上的 wikis 可帮助你以有用的方式提供项目的详细信息。

在你的项目中至少有一个 README 是个好主意，因为这是许多人第一次找到你的工作成果时会读到的东西。

> 最后更新：2016 年 7 月 15 日