連載
» 2010年09月14日 00時00分 公開

誰にでも分かるSEのための文章術(13):「目次」の良し悪しが、すべてのマニュアルの良し悪しを決める (1/2)

「提案書」や「要件定義書」は書くのが難しい。読む人がITの専門家ではないからだ。専門用語を使わず、高度な内容を的確に伝えるにはどうすればいいか。「提案書」「要件定義書」の書き方を通じて、「誰にでも伝わる」文章術を伝授する。

[谷口功,@IT]

 「マニュアル」は、システムの概要や使い方を顧客に理解してもらうために必要な文書です。SEにとって、マニュアルは非常に重要な文書です。分かりやすいマニュアルを顧客に提供しておかないと、顧客に不便をかけるだけでなく、開発側もさまざまな問題に巻き込まれる恐れがあります。

 そこで、今回から2回にわたって「分かりやすいマニュアル」を記述するポイントを説明します。今回は、下記の項目について説明します。

  • マニュアルを作成する際に必要な考え
  • マニュアルの種類
  • マニュアルの構成

なぜ、きちんとしたマニュアルが必要か

 そもそも、なぜきちんとしたマニュアルが必要なのかを考えてみましょう。まず、顧客側の不利益が考えられます。必要な情報を網羅したマニュアルを顧客に提供しておかないと、顧客に迷惑をかけてしまいます。

 SEにもさまざまな不利益があります。例えば「顧客対応」です。マニュアルが整備されていないと、本来しなくてもよい作業に時間と労力を費やさなければならなくなります。顧客は、システムを運用しているときに生じる問題点・疑問点を解決するため、あるいは障害から復旧させる方法を知るために、頻繁にSEや営業に連絡してくるでしょう。


 これでは、応対だけで手一杯です。顧客側も不要な労力を費やすことになり、結果として双方に不要なストレスがたまります。きちんとしたマニュアルを提供しておけば、致命的な障害が生じた場合を除き、顧客はマニュアルを頼りに自力で解決できます。

 また、補償問題などを発生させないためにも、きちんとしたマニュアルは必要です。PL法(製造物責任法)では、マニュアルも製造物とみなされるため、PL法訴訟の対象になり得ます。そのため、マニュアルの不備が原因で顧客に損害を与えた場合は、訴えられる可能性があるわけです。

 現在、ITシステムは企業や社会の中核になっています。ひとたび問題が生じると、損害や補償が大きいものになってしまう可能性があります。これらの非常事態を発生させないためにも、きちんとしたマニュアルは整えておくべきなのです。

マニュアル作成時には「常に顧客のことを考える」

 マニュアルは、提供する相手と共有する知識が少なければ少ないほど、作成が難しくなります。

 例えば、基盤ソフトを開発したSEは、アプリケーションソフトを開発するエンジニアに向けて、開発に必要な情報(インターフェイス、関数・サブルーチン・コマンドの使い方、データ形式など)を詳述したマニュアルを提供します。また、顧客のシステム部門担当に向けて、システムの管理や修正・変更に必要な情報(システムの仕組みや内容、システムを構成するプログラムやシステムで使われる技術・方式などの詳細)を記載したマニュアルを提供することもあります。

 これらのマニュアル作成は比較的簡単です。なぜなら、読み手がエンジニアであり、SEと同レベルの知識を持っているからです。ところが、エンドユーザーである顧客は、SEほどのIT知識を持っていません。こうした読み手に対して、読み手が求める内容のマニュアルを作成するのは一苦労です。

 マニュアルを読みやすく分かりやすいものにするため最も重要なこと、それは「常に顧客のことを考える」ことです。では、「常に顧客のことを考える」とは具体的にどういうことなのでしょうか? 以下、手順を説明します。

(1)顧客の知識レベルを想定する

 まず、顧客がITについてどれくらいの知識を持っているかを考えます。そのうえで、専門用語は読み手が理解できる範囲のものだけを使うようにし、難しい知識や情報は噛み砕いて説明します。

(2)顧客がどんな情報を必要としているかを考える

 顧客がどのような知識や情報を必要としているのか、顧客の立場に立って考えます。そして、顧客が必要とする知識や情報を過不足なく提供します。顧客にとって、どのような展開のマニュアルが使いやすいのかを考慮することも必要です。

マニュアルの種類を確認しよう

 顧客に提供するマニュアルには、いくつか種類があります。

操作マニュアル

 システムの使い方、操作方法を記述するマニュアル。システムの起動や終了の仕方をはじめ、システムが備えるすべての機能の使い方、その機能を使う際の操作方法を詳細に記述。

業務マニュアル

 システムを使った業務の進め方を記述するマニュアル。1つひとつの業務の流れ・手順を記述するとともに、流れ・手順のどの時点でシステムのどの機能を使うのかが分かるように記述。機能の使い方や操作方法を記述する必要はなく、それらの情報は操作マニュアルに任せる。

障害対応マニュアル

 システムに障害が生じた時の対応処理の方法を記述。ただし、エンドユーザーが自力で対応、解決できる範囲の障害だけに限る。自力で対応、解決できない障害(重大、致命的な障害)はエンジニア(顧客のシステム管理者や開発側の窓口担当など)に連絡するように記述。

システムマニュアル

 システムの仕組みや構造、全体的な構成などを基本から分かりやすく説明。エンドユーザー向けであり、システム管理者やエンジニア向けのマニュアルのような詳細かつ専門的なものではなく、入門レベルの概要的なものになる。

 これらの中で特に重要なのは「操作マニュアル」「業務マニュアル」「障害対応マニュアル」です。

 システムの中で、市販されていない特殊な機器や特注の機器を採用している場合、上記のマニュアルのほかに、機器の操作法や扱い方を記述した「操作説明書」を顧客に提供します。これらは一般的に、機器を提供するメーカーに作成してもらいます。もちろん、専門レベルの説明書ではなく、顧客向けの操作法や扱い方に特化した、簡潔な説明書でなければなりません。

       1|2 次のページへ

Copyright © ITmedia, Inc. All Rights Reserved.

RSSについて

アイティメディアIDについて

メールマガジン登録

@ITのメールマガジンは、 もちろん、すべて無料です。ぜひメールマガジンをご購読ください。