« 私が使ったおすすめ!赤ちゃん用品 | トップページ | [P2P]DHTのグリッドへの応用を考える »

2007.08.30

書籍執筆に大活躍したプロジェクト管理ツール「trac」

□はじめに

P2P技術入門書を書く上で大変だったのは10人弱もの執筆者の原稿を管理することでした。毎日、あるいは毎時改訂される原稿の差分をチェックしたり、あるいはレビューをすることは、とても大変なことです。

そこで今回活用したのが無料のプロジェクト管理ツール「trac」です。tracのおかげでドキュメント管理やレビューがスムーズに行われ、執筆プロジェクトがデスマーチにならずに済みました。

使ってる? Issue Tracking - trac 楽々ことはじめ

通常、この手のプロジェクト管理ツールはソフトウェア開発の進捗管理・ソースコード管理に使われる事が多いのですが、複数人のドキュメント執筆にも大いに活躍できる例として今回の執筆の状況を説明します。なお、tracの導入を推薦し、実際導入したのはP2P技術入門書執筆者の1人の亀井様であることを書いておきます。

□trac導入前
当初は執筆陣でMLを作り、MLに最新ドキュメントを配布するという手法を取っていました。しかしこの方法には3つの欠点があります。

[欠点1]ドキュメントの差分がわからない
[欠点2]どのドキュメントが最新版だかわからなくなる
[欠点3]ドキュメントを参照しづらい場合がある

欠点1はWordファイルのコメント機能を使えば補えるかもしれません。しかしtxtファイルではコメント機能は使えません。また大量のドキュメントがあると、差分をチェックするのも大変です。

欠点2はMLにコメント等が大量に送信されるとドキュメントが埋もれる場合を指します。またタイトル等によっては最新のドキュメントが検索に引っかからなかったりする場合もあります。

欠点3の要因は大きく分けて2つあります。ひとつはファイルサイズの大きなドキュメントはメールできないこと、もうひとつはメインのメーラーがないパソコン以外からの参照ができないことです。もちろん後者はWebメールを使えば解消できます。

□trac導入後
ではtrac導入後では3つの欠点はどのように解消されたのでしょうか?

[特徴1]ドキュメントの差分が簡単にわかる

tracを導入すると、ドキュメントの差分が発生する度にリビジョン番号が振られます。差分発生毎にリビジョン番号はインクリメントします。2つのリビジョン番号を入力すると、両者のリビジョンの差分が一覧表示されます。さらに過去のリビジョンのドキュメントも参照できます。うっかり変更しすぎたり、削除しても簡単に元に戻せます。

[特徴2]ドキュメントの最新版が一目で分かる

tracにログインすると、最新版のドキュメントリストが一覧で見ることが出来ます。またドキュメントのアップロードや更新に私はIEのプラグインで利用できるTortoiseCVSを利用しました。これならIEを使って最新版を簡単にチェックできます。

ただし、TortoiseCVSはWebDAVを使っているので、社内網からアクセスする場合にはWebプロキシの一部が通過できない場合があります。私の会社ではうまく利用できなかったので、専ら自宅で最新版をチェックする時に利用しました。

[特徴3]インターネットが通じればどこでもチェック可能

tracにはリポジトリブラウザ機能があり、ドキュメントをWeb上からチェックできます。このリポジトリブラウザ機能の優れているところにWordファイルもブラウザ上で表示してくれることにあります。Wordの表もきちんと表示します。(*ただし表示が崩れる場合がありますが。)
残念ながらPowerPointや図入りのWordファイルはリポジトリブラウザから閲覧することができませんでした。なおTortoiseCVSなどを使えば、ファイルサイズが大きいドキュメントも楽々アップロードできます。

□利用後の感想
3つの特徴を説明しましたが、Web上にドキュメントを置く事で複数人によるレビューが同時並行でできたのが一番うれしかったです。やはり複数人の執筆者が居る時にはドキュメント管理は重要です。またwiki機能を使って目次や執筆者肩書き等も管理しました。

コメントについてはドキュメントに書き込む方法もありましたが、結局MLに流す事としました。MLに流す事で全員がコメントを読むことができ、且つコメントに対して執筆者全員でディスカッションできる、素早くレスできるのが理由の一つです。

Tracを使えば簡単にドキュメント管理ができます。複数人、特に4人を超えたドキュメント執筆プロジェクトがあれば、効果は絶大です。結局ドキュメント管理に重要なのはドキュメントとドキュメントのメタデータの集中管理なのです。

 

最後にtracに対する要望を挙げておくと、一番欲しい機能はブラウザ上からファイルの編集が可能である事です。ソースコードと違ってWordやPowerPointでドキュメントを作成していたということもあるのですが、企業用の多くのドキュメントがWordやPowerPointで作成させている現在、なんとか機能として盛り込んで頂きたいものです。

今回はtracの一部機能しか有効活用してなかったので、次回はもっとtracを使い倒したいと思います。

|

« 私が使ったおすすめ!赤ちゃん用品 | トップページ | [P2P]DHTのグリッドへの応用を考える »

P2P」カテゴリの記事

コメント

コメントを書く



(ウェブ上には掲載しません)


コメントは記事投稿者が公開するまで表示されません。



トラックバック

この記事のトラックバックURL:
http://app.cocolog-nifty.com/t/trackback/18781/16282683

この記事へのトラックバック一覧です: 書籍執筆に大活躍したプロジェクト管理ツール「trac」:

« 私が使ったおすすめ!赤ちゃん用品 | トップページ | [P2P]DHTのグリッドへの応用を考える »