如何为我的开源项目创建优秀的文档？

Question

完成一个开源项目后，您需要有一个扎实的文档网站，让人们了解如何使用代码。

我遇到过一些好的文档示例：

http://guides.rubyonrails.org/

http://vowsjs.org/

http://codeigniter.com/user_guide/

http://expressjs.com/

我以前从未在网络上创建过任何文档，希望听到一些工具建议，以便轻松创建像上面那样整洁的文档。

此外，有人使用Drupal创建文档吗？

- ajsie

---

有人投票将此问题关闭为“不是一个真正的问题”。我认为这是一个真正的问题，但它是一个重复的问题。此外，问题的标题 - “Solid documentation website” - 不表明正在询问什么。要了解有关此主题的真正问答，请访问http://stackoverflow.com/search?q=generate+documentation，特别是http://stackoverflow.com/questions/2001899/creating-great-api-documentation-tools-and-techniques。此外，您没有说明谁将使用文档或文档涵盖的内容。它是API文档，开发人员工具文档，IT专业人员文档等吗？ - Cheeso

可能是创建出色的API文档：工具和技术的重复问题。 - Cheeso

@cheeso：将使用文档的用户与我提供的示例链接文档的用户类似。 - ajsie

Answer 1

这里有pdoc，还有一个示例

- meder omuraliev