FCFG100114601_TP_V-2

システム開発の仕事は、単にソフトを開発するだけではありません。システムを構築してそれを広く使ってもらうには、操作用のマニュアルを作成する必要があります。ごく小規模なシステムを除き、ほぼすべてのシステムに対してマニュアル(操作説明書)が必要になると考えて良いでしょう。

しかも、業務システムはパッケージソフト(製品として販売されている標準的な機能を持つソフト)と違ってほとんどの場合、システムごとに動作や仕様が異なります。そのため「マニュアルは、一つ一つのシステムごとに作成する必要がある」のです。このようにマニュアル作成の手間は、システム開発において決して軽微なものではありません。

ここでは、業務システムのマニュアル作成に関してわかりやすく、かつ早く作るにはどうしたら良いかについてお話ししていきます。ここで述べる内容を理解することで、システム開発における効率的なマニュアルの作成方法が習得できます。そして、一般的なシステム開発における文書作成のテクニックについて理解を深めることができます。

想定される読み手を正しく認識して作成する

操作マニュアルは、システムの全機能の操作方法を一つ一つ説明するものではありません。仮にそのような内容のマニュアルを作ってしまったとして、それを読んだ人はどのように感じるでしょうか。

きっと、「このシステムは、こんなにたくさんの機能を全部覚えなければ使えないのか」「結局のところ私は、このシステムをどのように使えば良いのかわからない」と不満を感じるに違いありません。

操作マニュアルを作成する際の留意点として最も重要なのは、「想定される読み手を意識すること」です。このことは、常に頭に入れておいてください。そして想定される読み手は、一つのシステムに対して複数の役割や権限に分かれることが多いです。

例えば、社員の出張経費を入力して精算するシステムを考えてみましょう。このシステムの場合、想定される読み手の役割は「一般社員」「承認者」(※1)「経理・会計担当者」「システム管理者」などになります。

※1:承認者自身が経費を精算するときは、さらに別の人が承認者になるといったこともあります。

システムの操作は、こうした読み手の役割によって異なってくるものです。したがって、マニュアルを作るときも「読み手の役割に応じて作る」ことが重要になってきます。

読み手の役割に応じて作るといっても、読み手ごとに冊子を分けることまでは必要ありません。しかし、想定される読み手ごとにページを分けたり章を分けたりしてそれぞれの読み手が行うべき操作を理解しやすいように伝えることが大切です

一つの文章や図で多くのことを説明しない

操作説明の文章は、どうしても一つの文章でまとめて多くのことを説明しようとしてしまいます。その結果、文章が長くなりがちです。しかし長い文章は、読み手が読みにくいだけでなく説明内容がぼやけてしまうという欠点があります。

そこで、一つの文章はなるべく短くするように心がけましょう。文体についても、能動態を使うようにしましょう。受動態や二重否定のような文体は、主語が不明確になったり冗長になったりするので避けてください。

一つの文章を短くした結果、一つの機能を説明するために複数の文章が必要になることが多くなります。そのような場合、箇条書きを使って文章の構成をわかりやすくしましょう。

ソフトウェアの画面を使った説明には、画面キャプチャーの図を貼り付けることが多いです。このときも、一つの図で多くの操作を説明するのはやめましょう。

一つの図に多くの説明が書いてあると、読み手が図のどこを見れば良いのかがわかりにくくなります。それだけでなく、図をどのような順番で見ていけば良いのかもわかりにくくなります。

画面キャプチャーを手早く行うには、専用の画面キャプチャーツールを使うのが良いでしょう。通常、画面をキャプチャーして文書に貼り付けるためには複数の操作が必要です。しかし画面キャプチャーツールを使えば、より少ない操作で図を貼り付けることができて手間が省けます。

したがって、画面キャプチャーを頻繁に行う場合は画面キャプチャーツールを使うことでかなり作業効率が上がります。画面キャプチャーツールは、フリーまたは有償のソフトが出回っています。詳しい人に聞いてみるか、または検索エンジンなどで探してみてください。

このように、業務システム開発においてわかりやすいマニュアルを早く作るテクニックは重要です。マニュアルを作るときは、読み手を常に意識して記述する内容を整理するようにしてください。

そして、説明文の文体や図の説明に注意を払うことと、必要に応じて画面キャプチャーのツールを利用することも有効なテクニックになると言えます。そのようなテクニックを使うことで、わかりやすいマニュアルを早く作ることができるようになります。