Rubyベストプラクティス 第8章 上手なプロジェクトメンテナンス その1

第8章ではドキュメントやプロジェクトのディレクトリ構成などあまり他に類のないトピックをあつかっているようです。やや長いので3日くらいに分割して読むくらいのペースで行きます。

  • まずは Haml を例に上げてレビューしていく
    • README.rdoc に Haml とは何なのか、何に使えるのかが書いてある
      • これ超重要ですよね。README の先頭を見てそのプロジェクトが何なのか説明してないとよっぽど重要じゃないとそれ以上見る気がなくなりますもんね
    • README にインストール方法(まあ今なら gem でしょうけど)、使用例(これも重要。ドキュメントが rdoc だけだとぱっと使いかたがわからない)が書かれている
    • rdoc で API ドキュメントを自動生成している
    • rake でタスクを自動化している
    • テストがある
      • テストのディレクトリ構成が一貫している(Haml::Engine のテストは test/haml/engine_test.rb に)
      • テストを見るとライブラリの利用方法がわかる
    • VERSION ファイルにバージョン番号を格納

今日は Haml の例を見るところまでです。