【わかりやすいマニュアルの作り方】第12回 目次構成案のデバッグはどうする？

第12回です。

第11回はちょっとずれましたが元に戻って、だんだん技術的な話になってきました。

目次構成案のデバッグ（承前）

今回は、目次構成案のデバッグの話の続きです。
前回はチェックシートを作成するところまで書きました。

問題はこのチェックシートです。目次構成案は、仕様書があれば作ることができますが、チェックシートの作成は、目次構成案を作成するよりも経験が必要なのです。
「こういう仕様ならこれとこれがあるのが普通だな」「機能Ａと機能Ｂがあるなら、これらの連携があるのではないか」といったところで勘が働かなければチェックシートは作れません。

こういったことは仕様書には記載されていますが、一件関係なさそうな設定が機能Ａの設定項目だったり、ユーザーはしばしば使うにも関わらず、設定項目が少ないために仕様書では簡潔に記載されているだけということも多いのです。

ここまでですでに気が付かれた方も多いでしょうが、これはソフトウェアで要求仕様書から詳細な機能仕様書を作成するのとほぼ同じ作業です。
ですから、逆に言うと、仕様書から目次構成とチェックシートを作りやすいものは、仕様書の設計が優れているといえます。そして、結果的に製品も使いやすく、マニュアルも読みやすくなります。

おっと横道にそれすぎました。
テストということで、話を続けます。
それでは、次回から実際にほぼすべての機器やソフトウェアに搭載されている機能「起動と終了」をサンプルとしてみてみましょう。
続きます。