マニュアルの説明文はどのような文体で書かれているのか、すぐに思い浮かびますか？
マニュアル作成の担当になりたての頃、マニュアルの説明文は能動態なのか受動態なのか、です・ます調なのか体言止めなのかなど、説明文の書き方について悩みました。
わかりやすいマニュアルを作るためにどのような文体がいいのか考えました。
いろいろなマニュアルを読んでみたり、実践していくうちに一つの結論が出ました。
それは、ユーザーが行なった操作と結果をワンセットで書くとわかりやすいということです。
今回はマニュアルの説明文の形についてまとめました。
んでは、どうぞ！
■ 目次
説明文はユーザーの操作＋結果を書く
何をしたら、どうなるのか理解しながら進めることで、ユーザーは自身の操作内容が正しいのか確認しながら進められます。
理解しながら進めるため、ユーザーは安心しながら操作できます。
マニュアルの「操作」と「結果」とは
操作ではユーザーである操作者自身の行動を書きます。
結果では操作者の操作後に起こることを書きます。
ユーザーの操作＋結果を書くメリット
ユーザーの立場で操作手順が進むため、理解しながら操作することができます。
つまり、ユーザーにとってわかりやすいマニュアルになります。
ユーザーの操作＋結果の例文
たとえば、スケジュールを登録する場合、以下のように書いています。
１.スケジュール一覧画面の「新規登録」ボタンをクリックします。(←ユーザーの操作)
スケジュール登録画面が表示されます。(←結果)
２.件名、日時、内容を入力します。(←ユーザーの操作)
３.「保存」ボタンをクリックします。(←ユーザーの操作)
指定した日時にスケジュールが表示されます。(←結果)
１と３はユーザーの操作に対して、画面に何らかの結果が反映されるため、ユーザーの操作＋結果の形で書きます。
２はユーザーの操作自体が結果になるため、ユーザーの操作内容のみ書きます。
ユーザーの操作のみ書いても分からなくはないですが、結果を書くことで、自分がどの状態なのかわかると安心感を与えることができます。
まとめ
ユーザーがマニュアルを開くときは、基本的に困ったときであると考えましょう。
ユーザーが理解しながら操作できると、安心感を持ちます。そうすると、わかりやすいマニュアルへの第一歩です。
操作手順は「ユーザーの操作＋結果」を書きましょう。
