【わかりやすいマニュアルの作り方】第14回 では「仕様書」にはどう書いてある?

第14回です。

前回はここまででした。

>ではこういったこと(追記:各種の起動と終了の操作)は仕様書にはどう書いてあるでしょうか。

実際、これらはまとめて書いてあることは、まずありません。

仕様書にはどう書いてある?

仕様書としてはどのようになっているでしょうか。
これに関しては、仕様書を作る際の手順を想像するとわかってきます。

ハードウェアでもソフトウェアでも「初期動作」の項目の仕様書を作ります。これは、ひとかたまりになっている場合がほとんどです。
では、2回目以降はというと「通常動作を参照」で、ここには書いてありません。通常動作の起動の項目を参照することになります。
さらに、異常終了時や、メンテナンスモードでの起動などはやはり別になっているのがほとんどです。

なぜなら、それらはユーザーにとってみれば「起動」の操作のバリエーションにすぎませんが、仕様書を作成する場合は「系」が異なっているためです。

もちろん、仕様書は設計のためのものでごく一部を除いて論理的に作られています。
しかし、その論理は作る側の論理で、使うユーザーからみた論理とは異なっています。
ユーザーは…言い方は悪いですが、表面あるいはユーザーインターフェイスしかユーザーはさわりません。
したがってマニュアルを制作するものは、ユーザー側からみて仕様書を再構成する必要があります。
この構成変更はユーザーの使い方を想像する想像力と、仕様書全体を見通す「仕様書の読解力」の両方が必要になります。

続きます。


タグ: , , , ,

コメントをどうぞ