JBoss Application Server Guideの課題

JBossAmazonのレビューを読んで今こそ真剣にドキュメンテーションの改善に取り組むべきです。

JBossはアプリサーバに関してGetting Started GuideとJBoss Application Server Guideの二種類を提供していますが、前者はスタート・ガイド、後者は(実質的には)コミッター向けの内部ドキュメントであり、この間に相当する一般ユーザ向けの文書がごっそりと欠落しています。

特にJBoss Application Server Guideは課題が多いです。これは確かにモジュールの詳細情報を提供していますが、その前提となる背景知識が多すぎですし、一般ユーザの利用目的や便宜という観点から見ると何を"Guide"しているのか不明です。システムの障害発生時に参照してもあまり得るものはないでしょう。

日本では更に輪をかけてこの状況は悲惨です。まず、J2EEの仕様書が翻訳されていません。無論、一般の開発者がJ2EE仕様書すべてに精通している必要はありませんが、JBoss Application Server Guideで参照されている概念やDTDなどは明らかに仕様書を知識が無いと読みこなすことができないと思われます。

では、ドキュメンテーションを改善するとしたら、何から手をつけたら良いのでしょうか。
(次回へ続く)