正文
//docs.writethedocs.org/
*
Conference
:
http
:
//conf.writethedocs.org/
上面的文字将渲染成标题，下面带着列表。URLs 将会被自动超链接。这写起来很容易，不但作为纯文本有意义，而且还能很好的渲染成 HTML。
README
你第一个应该写的文档是 README。如果你提供了合适的扩展名，代码托管服务会自动把你的 README 渲染成 HTML。它也是大多数用户跟你的项目的第一次互动。所以，一个可靠的 README 对你的项目十分有用。
有些人甚至 从 README 开始做项目。
文档写什么
现在我们来讨论重要的事情。确保你的用户能得到他们需要的所有信息，但不要太多。
首先，你需要问自己：文档是为谁而写。一开始，你只需要吸引两类的读者：
用户是指那些只是想使用你的代码，而不管关心它怎么工作的人。开发者是指那些想要给你的代码做贡献的人。
你的项目解决了哪些问题
很多人会通过你的文档搞清楚你的项目是什么。有人会提到它，有人会随机地用 Google 搜索一个短语。你应该解释你的项目做了什么和它存在的意义。Fabric 这方面做的很好。
一个代码的小例子
提供一个生动的例子来告知用户你的项目通常会被用来做什么。 Requests 是一个很好的例子。
一个代码和问题追踪的链接
人们有时候喜欢浏览源代码。他们可能对归档他们发现的代码 BUG 感兴趣。尽可能地让那些想要为项目做贡献的人做这件事很容易。我认为 Python Guide 做得很好，因为它有指向代码部分的链接。
常见问题（FAQ）
很多人会有相同的问题。如果问题一直发生，你应该适当地修改你的文档或者代码来解决问题。但是总是有一些经常被问的关于项目的问题，不能改变的的事情等。把这些记录在文档中，并且使其保持最新。FAQs 通常会过时，但当它们被很好的维护时，它们就是黄金资源。 Tastypie 做得很好，它把 FAQs 整理成“Cookbook”。
如何获取支持
邮件列表？IRC 频道？文档要记录如何获取帮助和跟项目社区交流。 Django 这方面做得很好。
给贡献者的信息
在项目中，人们通常有怎么做事情的标准。你应该记录在文档上，以便于别人写代码时能符合项目的标准。Open Comparison 这方面做的很好。
安装说明
一旦人们决定使用你的代码，他们需要知道如何获取它和运行它。但愿你的安装指令只有几行用于基本使用。如果有必要，给出提供更多信息和说明的页面链接。我认为 Read the Docs 中我们做得很好。
你的项目许可证
BSD?MIT? GPL? 这些证书可能对你来说没什么，但是使用你代码的人会很关心这个。考虑一下你想要用什么证书发布你的项目，务必选择一个互联网上的标准许可证。
下一步做什么
在你遵循上面的指南之后，我们相信你的项目将会成功。进一步的参考资料，查看这篇文章 如何维护一个开源项目(https://medium.com/p/aaa2a5437d3a)。
模板
给你一个 README 的模板。如果你使用 markdown 的语法，把它命名为 README.md。如果你使用 reStructuredText 的语法，把它命名为 README.rst。
$
project
========
$
project will solve your problem of where
to
start with
documentation
,
by
providing
a
basic explanation of how
to
