如何为我的开源项目创建出色的文档?

时间:2021-05-05 15:02:19

After finishing an Open Source project you have to have a solid documentation website to let people understand how to use the code.

完成一个开源项目后,你必须有一个可靠的文档网站,让人们了解如何使用代码。

Examples of good documentations I have stumbled upon:

我偶然发现的好文件的例子:

http://guides.rubyonrails.org/

http://guides.rubyonrails.org/

http://vowsjs.org/

http://vowsjs.org/

http://codeigniter.com/user_guide/

http://codeigniter.com/user_guide/

http://expressjs.com/

http://expressjs.com/

I have never created any kind of documentation on the web before and wish to hear some suggestions of tools to use to easily create as neat documentations as the above ones.

我以前从未在网上创建任何类型的文档,并希望听到一些工具的建议,以便轻松创建与上述文档一样简洁的文档。

Also, does anyone use Drupal to create documentation?

另外,有没有人使用Drupal创建文档?

1 个解决方案

#1


2  

There's pdoc, here's an example

有pdoc,这是一个例子

#1


2  

There's pdoc, here's an example

有pdoc,这是一个例子