マニュアル作成は難しい？

Think IT - マニュアルの作成は難しいものですか？

担当「非常に難しいものです。特にできるシリーズの場合は、画面をワンステップ・ワンステップで追っていく、非常に丁寧な紙面作りを行っています。ソフトウェア開発が進む中で仕様が変更されていないか、画面構成が変わっていないかなどを常にチェックする必要があり、手間をかけています」

Think IT - システムを発注する側として、本当にマニュアルだけ手元にあればよいのでしょうか

担当「それは『誰が見るのか」や『見る人の立場』『システムがおかれた環境』などに大きく依存すると考えています。単にシステムを使うだけのユーザであれば、マニュアルがあれば十分です。しかしシステムを利用する中で、他のシステムと連携する部分を開発するなど、将来的にシステムの拡張を行う際には仕様書が不可欠です。つまりユーザにとっては必要ないけれど、情報システム部門で開発・運用に関わる人には必須です」

Think IT - つまり、マニュアルと開発ドキュメントは両方必要なのですね

担当「結論としては必要だと思います。これは、『仕様書』をはじめとした開発ドキュメントはさらなる開発をするためのもの、『マニュアル』は使い方を記述したもの、という違いがあるからです。

また、同じ機能について開発ドキュメントとマニュアルに記載されていても、開発と使用、それぞれの目的によって書かれる内容は異なります。例えば仕様書には当然、システムのモジュール構成が記載されているでしょう。どこに何を追加すれば新機能を簡単に追加できる、といったことを読み取れます。しかしユーザマニュアルをみても書かれていないのです。

ただし、納品の時点で『開発完了』にするのであれば、仕様書がなく、マニュアルだけあればよいかもしれません。しかし現在のIT分野では、それはレアケースでしょう。例えば2000年問題を例にしますが、通常のマニュアルには対処方法までは記載されていません。問題が起こってはじめてその記述が必要になるわけですし、どこを修正する必要があるのかについては仕様書から読み取るべきものなのですから。

できるシリーズin企業

Think IT - システムを利用する側としては、やはり分かりやすいマニュアルも重要だと思いますが、企業の社内システムにもできるシリーズは適応できるのでしょうか

担当「実際に企業の社内システム向けに特化したできるシリーズも手がけています。もちろん体裁もそのままで、社内向けのマニュアルとして制作しています」

Think IT - そういった需要があるということは、社内システムのマニュアルに書かれた情報では不十分なのでしょうか

「それは世の中の企業システムが変わってきたことが影響していると思います。昔は企業システムといえばCUIベースで、容易に言葉だけで説明ができました。しかしWebアプリケーションをはじめ、GUIベースで運用される企業システムが増えています。このようなGUIのシステムについて説明するには、絵がないと伝えきれないものがあるのです。

そうした場合にできるシリーズのような『画面で解説する』タイプのマニュアルが重要になりますし、今後もその傾向は強まっていくと考えています。まさに『時代が変わった』という印象ですね」

読者の記事評価からスタートした本記事「ドキュメントvsマニュアル」について、どう感じただろうか。もし「わからない仕様書よりもマニュアルがあればよい」と思われているのであれば、それは今手元にあるマニュアルそのものが分かりにくいだけかもしれない。

マニュアルは開発ドキュメントの代替物とはなり得ない。しかしよいマニュアルがなければ、どれだけよいシステムがあったとしても、ユーザにとっては使いにくいものとなってしまう。つまり、どちらか一方ではなく、どちらも重要なのである。

この両輪が上手く回ってこそ企業システムは使いやすくなり、仕事の運営に対しても大きなメリットが生まれるものなのだ、といえるだろう。