[前][次][番号順一覧][スレッド一覧]

ruby:1477

From: Minero Aoki <aamine@l...>
Date: Tue, 20 Feb 2007 08:22:50 +0900
Subject: [ruby:1477] リファレンスマニュアル刷新計画メンバー募集

青木です。
このメールは日本 Ruby の会 ML と ruby-list に 
送信しています。

== 要旨

Ruby のリファレンスマニュアルを書くのを手伝ってくれる
人を募集しています。

== 概要

現在、Ruby の日本語リファレンスマニュアル
( http://www.ruby-lang.org/ja/man/ ) を徹底的に刷新しようという
プロジェクトが行われています。このプロジェクトの目的は、
より完全な、より高品質なリファレンスマニュアルを提供する
ことです。

現在のリファレンスマニュアルは、マイナーなライブラリの
ドキュメントが書いていなかったり、書いてあっても文章が
不統一だったり、実例がなかったりと、非常に混沌とした状況
にあります。

また、現在のリファレンスはフォーマットが固定されていない
ためにデータの再利用が困難です。おかげで、静的 HTML や
ReFe (リファレンス検索ツール) のデータベースを作るだけでも
無駄な手間を強いられています。もっと「固い」スタイルを使え
ばリファレンスマニュアルを今よりもいろいろな場面で活用する
ことができるはずです。

このような状況を改善することがこのリファレンスマニュアル
刷新計画の目的です。内容とフォーマットの両面でリファレンス
を刷新し、価値を高めます。

さて、プロジェクトは去年の秋からスタートしており、10 人弱
のメンバーによっていくらか作業が進められてきました。しかし、
これから作業が本格化するのにともなって、人数不足が深刻化
すると考えられます。

これまでは、本格的な作業と言うよりは、本格的にドキュメント
を書きはじめるための下準備をやってきました。具体的には、
すべてのライブラリのファイルを揃えて、すべてのライブラリの
クラスとメソッドを洗い出す作業です。今年の 1 月でようやく
その作業が完了して、これからいよいよドキュメントの本体を
ひたすら書く段階に入るわけです。しかし、メソッドをすべて
リストアップするだけでも 10 人で数ヶ月かかっているわけです
から、その中身をすべて書くとなると、作業量が半端ではあり
ません。

そこで、本プロジェクトでは追加メンバーを大々的に募集します。
リファレンスマニュアルの向上に関心のある人や、この機会に
自分の知識を高めたい人などなど、きっかけは何でもけっこうです。
ぜひプロジェクトに参加してください。具体的な参加方法などは
以下に記述します。

== 参加資格

このプロジェクトへの参加条件は特にありません。

このプロジェクトは日本 Ruby の会の活動として実施していま
すが、日本 Ruby の会に参加していなくともプロジェクトには
参加できます。

技術的には、まず Subversion が必要ですので、 
Subversion を
使えるようにしておいてください。Subversion の細かい使い
かたまではこちらではサポートできません。

また、プログラミングの知識が必要です。ドキュメントがまっ
たく存在しない場合もあるので、最低でも Ruby のコードが
読めることは必須です。さらに、拡張ライブラリのドキュメ
ントを書く場合は C の知識が必要になるかもしれません。

※ 担当になるライブラリは自分で選べるので、簡単な
ライブラリを選んでいくこともできます。技術力のある人は
できるだけ拡張ライブラリを優先的に記述してください。

== 参加方法

このプロジェクトに参加し、活動するには、最低でも二つの
手続きが必要です。

   1. ruby-reference-manual メーリングリストに参加すること
   2. doc.loveruby.net の Subversion アカウントを得ること

ruby-reference-manual メーリングリストに参加するには、

   To: ruby-reference-manual@m...
   Cc: aamine@l...

として、本文に簡単な自己紹介などを書いてメールを送って
ください。そのメールもメーリングリストに流れるので注意が
必要です。

Subversion アカウントを得るには、希望するアカウント名と
パスワードをわたし (青木) に直接メールしてください。 
わたし
が手動で登録します。

== その他

その他の情報や、プロジェクトの詳細についてはプロジェクト
の Wiki ( http://doc.loveruby.net/wiki/ ) を参照してくださ 
い。


以上、長文失礼いたしました。質問・疑問・意見などがあれば
このメーリングリストで受けつけますので、お気軽にどうぞ。

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

--
青木峰郎


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

[前][次][番号順一覧][スレッド一覧]