帶有文檔，源代碼管理和API文檔的RubyGems？

我一直在想，爲什麼這麼多的編碼人員在他們的文檔中組織不好。帶有文檔，源代碼管理和API文檔的RubyGems？

我想我知道爲什麼。

像往常一樣，它與標準化有關。如果沒有標準，每個人都必須重新發明輪子。

所以我在RubyGems.org上傳了一個gem。但那只是其中的四分之一。

我必須寫一個教程吧，製作類，文字樣式，大小，顏色等
我得從我的代碼生成API文檔
我不得不把它放在Git的輪轂（從來沒有這樣做，但這應該是正確的？）

這是一個痛苦的過程。

如果每個寶石遵循相同的文檔結構，這不是很好嗎？你上傳你的寶石，你爲它編寫一個文檔，每個人都可以編輯，API文檔也已經生成，也許會自動創建，如果你提供了你的賬戶信息。

一個好的過程。

我認爲這會促進良好的協作和環境，而不是每個創業板都有自己的結構（壞文件）並將API文檔放在這裏和那裏。

你不同意嗎？

來源

2010-08-27 never_had_a_name

羅，github不是必需的，但它很好。 – 2010-08-27 05:10:14

有一個Ruby包裝的標準草案：http：//chneukirchen.github.com/rps/你也可以看看這個問題：http://stackoverflow.com/questions/3307209/what-is-the-現代的方式對結構-A-紅寶石寶石 – Telemachus 2010-08-27 10:51:03

這種文檔（教程，非生成的文檔，...）最好由wiki來解決。

現在大多數公共資源容器都集成了一個功能。
GitHub最近改進了其own wiki system。
它還提出GitHub pages（通過簡單地推內容，以你的GitHub的一個內容發佈到Web託管庫，以用戶的頁面或項目頁面，並with Jekyll甚至更多Makdown文件格式）

alt text

來源

2010-08-27 05:50:21 VonC

如果更像這樣的風格，會不錯。對於維基社區內容可以改變的內容來說，這很有效。我發現寶石文檔有時可能會被擊中或錯過。我認爲可以編輯文檔是很好的，因爲人們可以重寫不清楚的部分，使其更加用戶友好

很好的建議！

來源

2010-08-27 05:49:35 TrentEllingsen

帶有文檔，源代碼管理和API文檔的RubyGems？

回答

相關問題