テクニカルライター歴10年以上の私が考える、“本当にわかりやすいマニュアル”とは？

2024年1月にチームスピリットに入社したテクニカルライターのyukaです。
Documentationチームに配属しており、「チームスピリット」のマニュアル作成に携わっています。
前任の方から「チームスピリット」マニュアルを受け継ぎ、日々「わかりやすいマニュアル」作りに精進しています。
本記事では、「テクニカルライター歴10年以上の私が考える、本当に良いマニュアルとは何か」についてお話します。

自己紹介

私は新卒でIT企業に入社してから現在まで、システム系マニュアル作りに携わってきました。
テクニカルライター歴としては15年ほどになります。
プライベートでは3人の娘がおり、仕事、家事、育児と毎日忙しい日々を送っております。

わかりやすいマニュアル作りのポイント

ここでは、わかりやすいマニュアル作りのポイントを説明します。
ここで紹介するポイント以外にも、フォントの使い分けやレイアウトなどの細かい要素がありますが、今回は特に重要なポイントに絞って説明します。

検索性が高い

大前提として、マニュアルを隅から隅まで読む人はほぼいません。自分が欲しい情報が書かれている部分のみ、読むはずです。
そのため、目次タイトルを見ただけで、どこに・何が書かれているかがわかるような目次構成にする必要があります。
読者がマニュアルを読む際、欲しい情報がどこに書かれているのかがわからないと、ストレスを感じてしまいます。
「チームスピリット」を例とすると、「有休を付与したい」、「残業申請ができるようにしたい」といった、目的別に見出しタイトルを設定します。
ちなみに、現在の「チームスピリット」マニュアルの見出しは目的別になっていないため、大規模改修を計画中です（誰か手伝ってください！）。

リード文から全体の流れがわかる

リード文とは、見出しタイトル配下の本文です。
リード文では、
・見出しを読むとできること
・見出し内の手順全体の流れ
などを記載します。

読者がリード文を読むことで、
・求めている情報があるか
・実現したいことができるか
がわかるようにしましょう。

1手順1文で書いている

1手順1文とは、以下のような書き方です。
①Aボタンをクリックします。
②Bにチェックを入れます。

悪い例は、以下です。
①Aボタンをクリックし、Bにチェックを入れます。
上記のように、複数の手順を1文で書いてしまうと、各手順の順番や内容が読み取りにくくなります。
システム系マニュアルでは、ボタンのクリックや各項目への入力などといった手順数が多いため、1手順1文で記載し、それぞれの手順を明示しましょう。

代名詞を使用していない

代名詞とは、「この」「その」「ここ」などといった表現です。
代名詞を使用すると、執筆者と読者との認識がずれてしまう恐れがあります。
代名詞は使用せず、必ず（固有）名詞を使うようにしましょう。

最後に：マニュアルは奥が深い

テクニカルライター歴15年の私ですが、「マニュアルって奥が深いな」と感じています。
よく、「テクニカルライターって、ある程度きれいな文章が書けたらできるんでしょ？」と言われることがありますが、「そんな簡単なものではない！」と声を大にして言いたいです！
製品仕様を正しく理解した上で、利用シーン、読み手のITリテラシー、目的などを具体的に想像して書くことで、製品価値を高めるためのマニュアルができます。
あとは、「無機質」であることも重要です。淡々とした表現の方が、内容がすっと入ってきます。
本記事を読んで、テクニカルライターの業務に興味を持たれた方は、是非、私たちと一緒に「チームスピリット」のマニュアル作りにチャレンジしていただきたいなと思います。