フォーチュンサモナーズ
最新 追記

Don'tStopMusic

2003|07|08|09|10|11|12|
2004|01|02|03|04|05|06|07|08|09|10|11|12|
2005|01|02|03|04|05|06|07|08|09|10|12|
2006|01|02|03|04|05|07|08|09|10|11|12|
2007|01|02|03|04|05|06|07|08|09|10|11|12|
2008|01|02|03|04|05|06|

カテゴリ別 2003年 | 2004年 | 2005年 | 2006年 | 2007年 | 2008年

知り合いサイト: よんだもの / 暴想 / Linuxでやる夫 / 新宿Vipper / 僕だけが幸せになればいいのに。


2006-08-13 この日を編集

_ [私生活]旅行 このエントリーを含むブックマーク

8/17-9/1 の間新婚旅行に行ってきます。南ドイツとオーストリアを周ってきます。ネットに繋がる機器はもっていきません。帰国したあとの bloglines の未読が恐いですね。

_ [メモ][Ruby]Rubyのドキュメント このエントリーを含むブックマーク

かれこれ 7 年くらい使っていると、主要なメソッドやイディオムは覚えているし、以前と比べれば、本はあるし、言語コアのリファレンスマニュアルは一通りの項目がそろっているし、RD や rdoc はあるしで、Ruby のドキュメントについては文句を言うところが見つかりません。

そろそろ出るプログラミングRuby 第2版でも買って読んでもらえれば事足りると思うのですがどうでしょう。Perl だって結局ラクダ本買うのだし。

とはいえ、すでに現状に慣れてしまった人を基準にしても詮無い話ですね。ということで、あるべきリファレンスマニュアルについて少し考えてみました。現在の Ruby リファレンスマニュアルが達成している項目もあれば、そうでない項目もあると思います。文章書きの方ならもっと良いポイントを知っているのでしょうけど。

  1. 章立て、項目分けが適切
  2. 表記が統一されている
  3. ソフトウェアの内容を網羅的に説明してある
  4. 探したい事項を探しやすくする工夫がしてある
  5. リファレンス内で説明が完結する
  6. 理解の助けとなる例がある
  7. 最新の内容に更新されている

ソフトウェアの内容を網羅的に説明してある

例えば買ってきたパッケージソフトで、メニューにあるのにマニュアルに記載がない機能があったとしたら、その機能が重要なものではなかったにせよ、マニュアルに対する信頼感が薄れるのではないでしょうか。Ruby でいえば、言語仕様、インストールされるコマンド、組み込みライブラリ、標準添付ライブラリのリファレンスが一通りそろっていることです。

探したい事項を探しやすくする工夫がしてある

例えば、検索、索引、逆引き、関連項目へのリンクなど。あるいは、Javadoc のように親クラスのメソッドリストなど。

リファレンス内で説明が完結する

せっかくのハイパーテキストですので必ずしもすべて抱え込むことはないですが、説明しない事柄については適切なページへのリンクが必要です。

理解の助けとなる例がある

マクロな例(ライブラリ単位)とミクロな例(メソッド単位)が必要です。組み込みライブラリは汎用ですが、標準添付ライブラリは特定用途のためのものが大体です。perldoc の synopsys のような、そのライブラリの典型的な使い方を示す例が必要だと思います。

最新の内容に更新されている

Ruby 本体の仕様変更に追随して更新されることです。

_ [Ruby] 世の中で Ruby がどれくらい使われているのか簡単に調べてみましょうコーナー 2006 このエントリーを含むブックマーク

以前行ってから 3 年経ちました。

SourceForge

  • 総プロジェクト数:126,880
  • Ruby: 678
  • ほかの言語を見てみると… C:17848 / C++:19863 / Java:21657 / PHP:15651 / Perl:6818 / Python:5872

freashmeatBrowse by Programming Language

  • Ruby:328
  • ほかの言語を見てみると… C:8213 / C++:4322 / Java:5045 / PHP:3832 / Perl:3644 / Python:2446

SourceForge.jpBrowse by Programming Language

  • 総プロジェクト数: 2,132
  • Ruby:105
  • ほかの言語を見てみると… C:307 / C++:272 / Java:358 / PHP:188 / Perl:82 / Python:50

最近のコメント:

RSS
Creative Commons License
This work is licensed under a Creative Commons License
(note: text only. w/o web design, citations, (re)distributed softwares).