PR

 「Javaの場合,JavaDocというツールでプログラム仕様書の作成を支援できる。だがJavaScriptにはそうした汎用的な支援ツールがない。工数を大きく増やすことなく保守を見据えてどのようにドキュメントを残すか。そこがポイントだ」(日本IBM 米持氏)。

 ドキュメントを残す場合,「仕様に関するメモ書きを含めてコード中に記述する」(Ajax対応のパッケージ・ソフトを開発したNIコンサルティング の上田氏)ケースが多い。ただし,JavaScriptのコードはクライアント側で丸見えになるので,「リリース時にツールを使ってコメントを削除する」(ミツエーリンクス 藤田氏)といった検討は欠かせない。

 こうした中にあり,大規模システムにAjaxを適用しているNTTデータの担当者らは,Ajax利用時に残すドキュメントを社内で標準化した。通常のWebシステムでは以前から6種類のドキュメント((1)要件から洗い出した画面の一覧,(2)画面遷移定義,(3)画面構成定義,(4)業務ごとの画面の定義,(5)各画面要素のレイアウト定義,(6)各画面要素の項目ごとの権限定義)を作成している。Ajaxのシステムではそれらに加え,(7)各画面要素の処理契機(イベント)と(8)イベントに対応する処理概要のドキュメントを作成する。

 その一方で,「ドキュメント化してもすぐに陳腐化するので無意味」(ピーデー 川俣氏)という見方もある。実際,ドキュメントを残すより,「実装を優先する」(オープンストリーム システム開発本部 エンジニアリングサービスグループ 箭内直樹氏)というITエンジニアもいる。ただこれは,設計・開発を1人か,多くても数人程度で実施するケースに限られる。「多人数での開発や,長期的にきちんと保守することを考慮すれば,なにがしかのドキュメントは残さざるを得ない」(インフォテリア 研究開発担当 中川智史氏)。