infoTek インフォテック株式会社

テクノロジー情報Technology

Technology16. マニュアル

アプリケーション開発者が、サービスの品質に直接影響を与えるものはアプリケーションだけではありません。マニュアルもまたサービスの品質に大きな影響を与えます。

多くの技術者にとって、文書化は苦手だったり、億劫に感じたりすることの多い作業です。しかしマニュアルは、運用担当者が間違いなくサービスを供給し、ユーザがストレスなくサービスを利用するための不可欠で重要なサービスの1要素です。

一般的に次の3種類のマニュアルが必要とされています。

[設計マニュアル]
アプリケーションの構造とアーキテクチャを説明する文書
[運用管理マニュアル]
アプリケーションがサービスの要件を満たすように機能させるため、アプリケーションの保守や運用に関するガイドラインや手順を説明する文書
[ユーザ・マニュアル]
アプリケーションの機能や操作手順をエンド・ユーザに説明する文書

文書化には時間とコストがかかりますが、重要なのは文書の量ではありません。必要な情報が関係者に確実に伝えられることです。マニュアルが整備されていないことで発生するコストとして、次のような事項が考えられます。

  • ユーザがサービスを利用しないことで生じる投資の無駄
  • 顧客が別のサービスに乗り換えることで失われる将来の利益
  • マニュアル不備に起因する操作ミスが事業に与える影響
  • ユーザや運用担当者が操作に手間取ることによる低い生産性

サービスマネジメントは、上述したような文書化しないことで発生するコストと、文書化にかかるコストのバランスを考慮して、マニュアルに 記述する内容や範囲を決定する必要があります。

マニュアルの品質が重要であることは分かっていても、現実の世界ではスケジュールやコストの関係で、文書化が犠牲になることも少なくありません。プロジェクト末期のトラブルを避けるためにも、成果物の受入れ基準をあらかじめ確立しておくことが必要です。

ITIL の観点からみると、マニュアルの内容や品質は、リリース管理によってコントロールされるべきものです。アプリケーションを供給する 開発組織はリリース管理プロセスの重要性を理解し、マニュアルの標準化や品質向上にも協力することが期待されています。