有文档、源代码管理和API文档的RubyGems?
我一直在想为什么这么多的程序员在他们的文档中有着糟糕的组织 我想我知道为什么 像往常一样,它与标准化有关。如果没有标准,每个人都必须随时重新发明轮子 所以我在RubyGems.org上传了一个gem。但这仅仅是全部的四分之一有文档、源代码管理和API文档的RubyGems?,ruby,open-source,rubygems,github,Ruby,Open Source,Rubygems,Github,我一直在想为什么这么多的程序员在他们的文档中有着糟糕的组织 我想我知道为什么 像往常一样,它与标准化有关。如果没有标准,每个人都必须随时重新发明轮子 所以我在RubyGems.org上传了一个gem。但这仅仅是全部的四分之一 我必须为它写一个教程,制作类别、文本样式、大小、颜色等 我必须从我的代码生成API文档 我必须把它放在GitHub中(从未这样做过,但应该是正确的?) 这是一个痛苦的过程 如果每个gem都遵循相同的文档结构,那不是很好吗。你上传你的gem,你为它写了一个文档,每个人都可
- 我必须为它写一个教程,制作类别、文本样式、大小、颜色等
- 我必须从我的代码生成API文档
- 我必须把它放在GitHub中(从未这样做过,但应该是正确的?)
你不同意吗?如果更像这样的风格就好了。wiki的内容可以由社区更改,这一点非常有效。我发现gem文档有时可能会出错。我认为让文档可以编辑会很好,因为人们可以重写不清楚的部分,从而使其更加用户友好
好建议 此类文档(教程、非生成文档等)最好通过wiki进行处理 现在,大多数公共源容器都在其功能中集成了一个。
GitHub最近改进了其功能。
它还建议(通过简单地将内容推送到GitHub托管的存储库之一,使用用户页面或项目页面,将内容发布到web上,以及使用更简单的文件格式)
不,github不是一个要求,但拥有它很好。Ruby打包有一个标准草案:您也可以查看以下问题: