マニュアルは誰のためにあるものでしょうか?
こんにちは。情報親方です。
マニュアルは誰のためにあるものでしょうか?
- 発行元:発行元が言い訳するためのもの?
- 開発者:ほぼ発生しない仕様も含めて、製品やサービスの仕様を全て書いたもの?
- 主従関係のある従業員:上司から付けろといわれたから付けるもの?
答え
マニュアルはユーザー(読み手)のものです。
- 「バグがあることを言われたら困るので先に書いておきたい」(いわゆる「言い訳」)
→製品やサービスを改善してから世に出してください。 - 「ほぼ発生しない仕様」だけど載せてほしい。
→ほぼ発生しないなら一般ユーザー向けのマニュアルに書く必要がありません。マニュアルは仕様書ではありません。 - 上司から付けろといわれた
→よく考えましょう。上司はユーザーの存在を理解していますか?
いいマニュアルを書くためには、発行元の要望を全てマニュアルに書くとは限りません。
視点は、ユーザーにとって役に立つか、です。