SEが仕事で使うときに、Tracはなんの役に立つか?という話。TortoiseSVNとバグ管理用のExcelと、あとメーリングリストがあればいいんじゃない?っていう嫌な質問に対する反論でもある。 (Trac自体の説明は、こことかこことか参照)
Tracって何の役に立つかと言うと、プロジェクトのメンバがBTSとか使って便利にプロジェクトを進めることができるっていうだけじゃない。重要な役割は、プロジェクトへの来訪者にプロジェクトの説明をする案内板としての役割だ。
プロジェクトにかかわる人には、バリバリ働いているメンバの他に、ある日突然くる来訪者ってのがいる。プロジェクトに(人の補充や後任で)途中から参加してきた人とか、よそのプロジェクトからノウハウを探しにきた人(ノウハウが見つかればすぐ去っていく)のことだ。途中参加者へ向けた案内とか、ノウハウを探しにきた人へ向けた情報の探し方とかが用意されていれば、そのときになって忙しいメンバの手をわずらわせる必要がない。TracのWikiスタートページや検索機能がその役割を果たしてくれる。
今までは(というか今は)どうか。
途中参加者に対して。
よほど上品なプロジェクトでも、「このファイルサーバのここに規約のExcelが置いてあるから。規約のリストはこのExcelを見て」なんて言われて、あとは全部口頭で説明。「ここに書いてあるのは古いから注意して」なんて言われたり。ファイルの置き場所はすぐ忘れちゃうし、書いてある情報は古い。で、その後は忙しいメンバと途中参加者との間でつまらない質問が繰り返される。そんなでは、参加者はなかなか「バリバリ働けない」。ひどいプロジェクトだと、すべて「習うより慣れろ」で慣れるころにはプロジェクトの大事な時期は終わっちゃってたり。あるいは、そもそもプロジェクトの説明できる人がいなかったり。普通は違う?そうでもないでしょ。
質問にきた人に対して。
その人が自分で情報を探せるようになんて当然なってない。どうなるかというと、プロジェクトの情報をよく知ってる人、つまり一番重要で一番忙しい人が相手することになる。
これが改善できるだけでも、かなりプロジェクトがスムーズになるはずだ。スタートページのURLを教えればいい(もちろん余裕があれば説明もしてあげるべき)。 スタートページに案内を書くのが面倒?でも、プロジェクトを手伝いに来てくれた人がすぐに力を発揮できるようになる。他のプロジェクトの質問に足を煩わされなくてすむ。感謝してくれるかもしれない。将来メンバ(自分も含めて)がプロジェクトを離れた後も、一生懸命作ったノウハウがファイルサーバの奥深くに忘れ去られなくてすむ。というわけで、プロジェクトの案内板こそがTracの本当に重要な役割だ。
おまけ:
Wikiスタートページには何を書いたらいいか。本文のとおり、突然の来訪者に向けた案内を書いておくべきだ。情報が古くなったらすぐ気づくよう、なるべく目に付くところがいい。随時メンテナンスしておけば、「いつお客さんが来ても大丈夫」となる。(The Meadow Projectのとか参考になるかも。)
現在のメンバへ向けた情報はむしろ奥にあってもいい。メンバは必要があれば必要なページをブックマークするので。まあ、実際にはメンバはWikiよりもTicketをよく使うんだろうけど。
具体的には何を書くか。参加した人への案内としては、プロジェクトの概要とか、最初に必要な事務処理(例えばアカウントの申請)とか
プロジェクトの規約(例えばTicketの登録方法)とかあればいい。
質問にきた人には、リポジトリの構成とかTicketの見方とかがいい。もちろん検索もできたほうがいい。
まあスタートページに書きすぎると見づらいので、適当にリンクを使って。
2006.01.31 | 考察 | トラックバック(0) | コメント(1) |
>プロジェクトの説明をする案内板
なるほど!
ドキュメントを作るのが、しんどいなーと思っていたので、Tracで説明できるような形になればいいなと思います。
参考になりました。
どうもありがとうございます!
(・∀・)
トラックバックURL↓
http://weekbuild.blog39.fc2.com/tb.php/15-82a5176e