如何爲我的開源項目創建出色的文檔？

完成開源項目後，您必須擁有一個可靠的文檔網站，讓人們瞭解如何使用代碼。如何爲我的開源項目創建出色的文檔？

我也偶然發現好單證的

例子：

http://guides.rubyonrails.org/

http://vowsjs.org/

http://codeigniter.com/user_guide/

http://expressjs.com/

我從來沒有創建任何類型的文件在網絡上和希望聽到t的一些建議可以使用ools輕鬆創建和上面一樣整潔的文檔。

另外，有沒有人使用Drupal創建文檔？

來源

2010-11-27 ajsie

有人投票決定關閉這是「不是一個真正的問題。」我認爲這是一個真正的問題，但它是重複的。此外，問題的標題 - 「實體文檔網站」 - 並不代表要問什麼。有關此主題的真實問答，請嘗試http://stackoverflow.com/search?q=generate+documentation，特別是http://stackoverflow.com/questions/2001899/creating-great-api-documentation-tools-and技術。此外，您不會說誰將會使用該文檔，或者其涵蓋的內容。是API文檔，開發人員工具文檔，IT專業人員文檔等？ – Cheeso 2010-11-27 18:59:54

有pdoc，這裏是一個example

來源

2010-11-27 17:50:09

如何爲我的開源項目創建出色的文檔？

回答

相關問題