スピーカー

青木 峰郎 - 日本Rubyの会

プロフィール

ふつうの文系SE。主著『Rubyソースコード完全解説』。
The author of "Ruby Hacking Guide", TMail, net/http.

講演時間

11：00〜11：25

講演者による資料

http://i.loveruby.net/rubykaigi2007/
http://i.loveruby.net/rubykaigi2007/rubykaigi2007-aoki.pdf

今日話すこと

• リファレンスマニュアル刷新計画とは
• 計画の進行状況
• 人材募集

Rubyリファレンスマニュアルとは

ここで実際に今までのマニュアルを表示して見せました。

リファレンスマニュアルの内容

• Spec
• class ref
• C API reference
• リリースノート

新しいのでも同じ内容で

全面刷新します。

今日のプレゼンは黒い地に白文字でした。「喪に服するという意味で黒にした」とのことです。

計画

• since 2006-08(LLRingで)
• 青木主導
• アクティブなメンバーは10人くらい
  • 自分では何もしないで指示すると働いてくれる

ここで実際のマニュアルを表示されました。青を基調としたシンプルなデザイン

• デザインはあとでかっこよくする予定
• デザイン重要

目標

• 「完全な」マニュアル
• より便利なシステム

目的１:「完全な」マニュアル

「完全な」とは？

• すべての言語仕様が記述されている
• クラス、メソッドなどの抜けがない
• 読みやすい文章だとなおよい

目的２：より便利なシステムを提供すること

「より便利な」とは？

• 的確で高速なメソッド検索
• 再利用が容易なデータ形式
  • いまはWikiなのでたとえばシグネチャの書き方が何通りもあったりする。
• メソッドの追加・再定義のサポート

計画の進行状況

どれくらい進んでいるのか？

当初の予定

• 2006-10-31 フォーマットの変換
• 2006-12-31 メソッドエントリを揃える
• 2007-08-31 すべてのドキュメントを書く

これはクラスリファレンスだけ。

実際どーなんだ？

• 2006-10-16 フォーマットの変換
  • 15日早く終わった（拍手）
  • 私はなにもしていないけどメンバーががんばった
• 2007-01-08メソッドエントリを揃える
  • 8日遅れ。ちょっとで済んだ
  • もっと遅れると思っていたけど、いつのまにか終わってた。メンバーががんばった。
• 完了率２％
  • 終わる見込みがない・・・

遅れてる原因

• 見通しが甘すぎ
• 拡張ライブラリが膨大。TKが全体の3分の1！！！
• 人手不足
• 青木の時間不足

協力者募集

• ドキュメントを書きたい人
• デザインしたい人
• ツールを書きたい人
  • 青木さんが時間がない
• （間違いを指摘したいひと）
  • あとのほうでがんばってほしい。作業してるときにちくちくされると；；

http://doc.loveruby.net/wiki/HowToJoin.html

みなさんの参加をお待ちしています。

質疑応答

Q

プロジェクトの協力をしている。TKがものすごく多いのを身をもって体験した。全体の3分の1だけど需要が3分の1もあるように思えない。重要度の高いものから作業を進めたほうがよいのでは？

A

よいのではないでしょうか。そういうアイデアを募集しています。

できれば11月にリリースしたい

Q

ページの長さがどれくらい？1.6で細切れになって使いにくくなった。

A

ネットワークに接続されていませんｗｗｗ

メソッドの概要からそれぞれのメソッドのページに飛ぶ

Q

ページが細かくなると使いにくい（クリック増える）

A

量が多くなった。動的に生成なのでどっちも出来るといいね。

Q

五十嵐　英語とか国際化はどうなるの？

A

共通であるに越したことはない。英語のほうはいまはRDoc。いままでの蓄積があるのでそれは生かしたい。フィードバックできる人がいたら協力してほしい。

Q

新しい本はいつ出るのですか？

A

それは聞かないで！

Q

ダウンロードして手元で使えるようにする？

A

それは出来るようにする。ツールはこれから作る。

(ロガー：よう)