A documentação é importante, mas às vezes a tratamos como uma reflexão tardia.
Torne sua vida um pouco mais fácil para qualquer projeto Ruby em que você trabalhe instalando primeiro o YARD. Aqui está um exemplo:
cd /path/to/project
rvm gemset create foo
rvm gemset use foo
gem install yard
gem install bundler
bundleAgora, todas as gemas terão documentos YARD gerados conforme você as instala.
Basta executar yard server -ge visitar http: // localhost: 8808 para ver os documentos de todas as joias do projeto.
Claro, você pode realizar a mesma coisa executando yard gemsa qualquer momento, mas acho que começar com ênfase em documentos ajuda a mantê-lo um pouco mais honesto com seus próprios esforços de documentação. Além disso, você não terá que esperar a geração de documentos sobre todas as joias de uma vez.
Seria legal se o RVM instalasse implicitamente o quintal e o bundler para você … ou pelo menos o tornasse opcional