マニュアルの作成について

東京アプリケーションシステム 第二ソリューション部 S.Rです。

前回予告の内容と異なりますが、現在業務で運用マニュアルの整備をしており、作業を進めるうちに私自身、色々と思う所があり、今回ブログで取り上げたいと思います。

 

■マニュアルは見ない

ある調査によると日本人の6割はマニュアルを見ないそうです。これは潜在的にマニュアルは「見づらいもの」という意識があるからだと思います。

マニュアルはたいていプロジェクトの終盤に作成します。時間もあまり無い中、何となく体裁だけ揃えて作成したものが殆どではないでしょうか。

そこに読みやすさの観点でチェックが入ることはあまり無いように思われます。

 

■余分な情報が多い

大抵のマニュアルはページを開くとこれでもかと情報が敷き詰められています。私はこれこそが読みづらさの最たる原因と考えます。

私自身がそうなのですが、例えば設計書を作成する際、情報は「多ければ多いほどよい」という思いで作成している節があります。作成者本人は親切で書いているつもりが、読み手にとっては見づらさに直結することに気づかないのです。

私自身、「情報を切り捨てる」という作業はこれまであまりしてこなかったように思います。

 

■目的の記載がない

開発者の作成するマニュアルでありがちなのが、手段の記載に終始する所です。手段(やり方、手法)は詳細に記述しますが、それを行う目的の記述が薄くなりがちです。

みなさんも保守マニュアルを渡されて、とりあえず意味もわからずマニュアル通りに一通り実行し、実行後に初めてその目的を理解したという経験がないでしょうか。

これはマニュアルとして本末転倒なだけでなく、「隅から隅まで読まなければ理解できないもの」という印象をマニュアルに与える一因になっていると思います。

 

■読み手の事を考える

作成したドキュメントが読み手にとって読みやすいものに仕上がっているか、推敲、見直しを行う。これ一つで大きく変わります。

開発者はプログラムは使い勝手を考慮して作成するのに対して、マニュアルは同様に考えてないように感じます。プログラムと違ってマニュアルはフィードバックの機会が少ないのも原因の一つかもしれません。

マニュアル作成はプログラムと違い答えがあるものではありません。色々思う所があり書き連ねてみましたが、読み手を意識したマニュアルづくりを心掛けたいと思います。

 

 

 

東京アプリケーションシステム

最近の記事

  1. 2022.01.14

    体が資本!
  2. 2022.01.06

    新年のご挨拶