PR

 前回まで、ドキュメントの骨格を組み立てるときに使う5種類のツリー構造を紹介した。今回は、その骨格の中に埋めていく文章(段落)や図表の構造を考える。これらはもともとツリー構造ではないが、ツリー構造という視点を持つことで分かりやすい説明が可能になる。前回の事例の続きを使って、説明していく。

 事例は、顧客に納品した自社システムの応答が遅くなったことへの対策を求められたというものだ。

 応答が遅くなった原因は、DB処理のパフォーマンスの低下だった。そしてその根本原因は、データ量の増加に比例して処理時間が増えたことと、後から追加された他社システムのデータ更新処理待ちが多発していることだと分かった。それらの原因への対応策として、それぞれに2つの打ち手が案として挙がった。

 さて、実際に対策を実行に移す前に、どの原因に対応すべきか、どの対策を打つべきかを判断する必要がある。以下で順に見ていく。

 どの原因に対応すべきかを評価した結果が図1だ。リリース時と現時点での所要時間の内訳を表した帯グラフである。図中の赤い数字と矢印については後述する。

図1●パフォーマンスの比較
図1●パフォーマンスの比較
[画像のクリックで拡大表示]

 こうした図は、提示するだけでは作成意図通りに読んでもらえるとは限らない。正確に伝えるためには、図表が表現していることの意味をテキストで記述する必要がある。以下に図1を説明した例を示す。

 この図は性能低下を指摘されている機能について、処理時間の内訳をリリース時と現時点で比較したものです。データサイズに依存しない処理時間(1)がほとんど増加していないのに対し、データサイズに依存する処理時間(2)は大きく増加しています。さらに、リリース時に想定していなかった、他社システムによるデータ更新処理待ち(3)が非常に大きな割合を占めています。このことから、今回の性能低下の主要因は他社システムによるデータ更新処理待ちであると考えられます。