青木です。

一昨日のオフライン検討会であーだこーだ言い合った結果、
今後のことが二つ決まりました。

(1) 予定

* 2006 年内にすべてのメソッドエントリを揃える
  (ドキュメントは書いてなくてもいい)
* 2007 年 8 月あたりまでにすべてのドキュメントを揃える
  (とりあえず品質は無視してよい)
* Ruby 1.8.7 or 1.9.1 が出るまでに品質を向上させる
  (1.9.1 は 2007 年内に出る、と笹田さんが言ってました)

より詳しい進めかたについては
http://doc.loveruby.net/wiki/ProjectTimeLine.html
を見てください。

※ ちなみに、この予定は「その時期に必ず達成しなければならない下限目標」
であって、それを上回るのはまったく問題ありません。たとえばメソッド
エントリを揃えると同時に文章を改善してしまっても構いません。とにかく
ドキュメント書かせろ、という人はガンガン書いてくれれば結構。

ただし、その場合も ASSIGN ファイルを使った編集権限割り当てだけは
守ってください。でないと作業が混乱するので。


(2) ドキュメントのフォーマット

いまはメソッドのドキュメントはフリーフォーマットですが、今後は
JavaDoc のように @param とか @return を導入します。形式をカッチリ
決めて、機械的にチェックすることが目的です。



なお、上記の話はクラスリファレンスに関してだけなので、他の部分もどう
にかしなければいけません。特に「Ruby言語仕様」はわたしが書かざるを
えないと思います。

とすると、「言語仕様」を書きながら同時にクラスリファレンスををいじる
のは非常に厳しいので、わたしはインフラ作りと内容チェックくらいしかで
きなくなると思います。C API リファレンスも同様です。

そういうわけで、すばらしいリファレンスマニュアルができるかどうかは
みなさんの頑張り次第です。みなさんのさらなる奮起に期待しています。

--
青木峰郎

--
ML: ruby-reference-manual@m...
使い方: http://QuickML.com/