带有文档，源代码管理和API文档的RubyGems？

Question

我一直想知道为什么这么多程序员在他们的文件中组织不好。

我想我知道为什么。

与往常一样，它与标准化有关。如果没有它的标准，每个人都必须一直重新发明轮子。

所以我在RubyGems.org上传了一个gem。但那只是其中的1/4。

• 我必须为它编写教程，制作类别，文字样式，大小，颜色等
• 我必须从我的代码生成API文档
• 我必须把它放在Git-hub中（从来没有这样做，但这应该是正确的？）

这是一个痛苦的过程。

如果每个宝石遵循相同的文档结构，那不是很好。你上传你的宝石，你为它编写一份文档，每个人都可以编辑，API文档也已经生成，如果你提供了你的帐户信息，也可以自动创建。

一个好的过程。

我认为这会促进良好的协作和环境，而不是每个gem都有自己的结构（糟糕的文档），并且在这里和那里放置API文档。

你不同意吗？

Answer 1

如果更像这样的风格会很好。它适用于wiki的社区内容可以更改的内容。我发现宝石文档有时会被击中或遗漏。我认为编辑文档会很好，因为人们可以重写不清楚的部分，使其更加用户友好

很棒的建议！

Answer 2

维基可以更好地解决这种文档（教程，非生成的文档......）。

现在大多数公共源容器都集成了一个功能 GitHub最近改进了own wiki system 它还建议GitHub pages（通过简单地将内容推送到您的GitHub托管存储库之一，使用用户页面或项目页面，以及with Jekyll更多Makdown文件格式）将内容发布到Web上