带有文档，源代码管理和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？

回答

相关问题