【发布时间】：2010-08-27 05:09:00
【问题描述】：
我一直想知道为什么这么多编码人员的文档组织不好。
我想我知道为什么了。
像往常一样，它与标准化有关。如果没有标准，每个人都必须一直在重新发明轮子。
所以我在 RubyGems.org 上传了一个 gem。但这只是全部的 1/4。
- 我要为它写一个教程，制作类别、文字样式、大小、颜色等
- 我必须从我的代码生成 API 文档
- 我必须把它放在 Git-hub 中（从来没有这样做过，但这应该是正确的？）
这是一个痛苦的过程。
如果每个 gem 都遵循相同的文档结构，那不是很好吗？您上传您的 gem，为它编写一个每个人都可以编辑的文档，API 文档也已生成，如果您提供了您的帐户信息，可能会自动创建。
一个很好的过程。
我认为这会促进良好的协作和环境，而不是每个 gem 都有自己的结构（糟糕的文档）并将 API 文档放在这里和那里。
你不同意吗？
【问题讨论】：
-
不，github 不是必需的，但有它很好。
-
有一个Ruby打包标准的草案：chneukirchen.github.com/rps你也可以看看这个问题：stackoverflow.com/questions/3307209/…
标签： ruby open-source rubygems github