こんにちは。トラストバンク パブリテック事業部 プロダクトグループのみきです。
自治体職員専用ビジネスチャットの「LoGoチャット」をメインに、複数の自社プロダクトをサポートしています。
LoGoチャット上でお問合せ対応をする中で、分かりやすい文章作成技術を学びたいと思うようになりました。
そこで今回は、書籍を通して学んだ「テクニカルライティング」について、紹介します。
テクニカルライティングとは
テクニカルライティングとは、技術的な内容を分かりやすく正確に伝えるための、文章作成技術です。
主に技術的なドキュメント、マニュアル、報告書などで活用されます。
また、社内でのテキストコミュニケーションなど、広く活用できます。
リモートで仕事をする機会が増えるにつれて、文章でコミュニケーションする機会も増えていますよね。
「うまく伝わらない」「どのように説明すればいいんだろう」など、文章作成の悩みは様々です。
文章作成にも、分かりやすく伝えるためのコツがあります。
何個かのコツを使うだけでも、文章がぐっと分かりやすくなります。是非普段の業務で取り入れてみてください！
テクニカルライティングのポイント
1. 一文一義で書く
1つの文に1つの意味を込めるという意味です。
複数の要素を詰め込みすぎると、読者が混乱します。
以下の例文を比較してみましょう。
悪い例：
「テクニカルライティングは、技術的な内容を分かりやすく、正確に伝えるための文章作成技術のことなので、この技術を活用して、分かりやすい文章を書く人になりましょう。」
良い例：
「テクニカルライティングは、技術的な内容を分かりやすく伝えるための、文章作成技術です。テクニカルライティングを活用して、分かりやすい文章を書く人になりましょう。」
いかがですか？前者と後者で意味は変わりません。
でも後者の方が、内容がすっと頭に入ってきませんか？
一文で色々な意味を盛り込まず、短く区切ることを意識しましょう。
2. 一文50文字程度で書く
一文が長すぎると、読者を混乱させます。50文字程度で書くことを意識しましょう。
以下の文章が50文字です。
「テクニカルライティング」を使って、技術的な内容を分かりやすく書くためのコツや活用事例を紹介します。
意外と短いでしょうか？
「～が」「～で」などの接続詞を3つ以上使うと、文章が長くなって分かりづらくなるので、注意しましょう。
3. 結論から書く
結論を先に述べることで、読者に「どんなつもりで文章を読んだらいいか？」を認識した上で読み進めてもらえます。
悪い例：
「歓迎会の場所ですが、繁忙期なので1席が狭くなるみたいです。また、Bさんがご家庭の事情で来れないそうです。そのため、歓迎会の日程を変更してもいいですか？」
良い例：
「歓迎会の日程を変更してもいいですか？予約した日は混雑で1席が狭くなるらしく、またBさんが来れないため、別の日に広い席を予約したいです。」
数行の文章の場合は、「結論→理由→詳細→結論」の順番で説明すると、分かりやすい文章が作りやすいです。
自分の書いた文章が結論から書けているか、点検してみましょう。
テクニカルライティングの活用シーン
1. 社内のコミュニケーション
リモートワークが広がっていくことで、テキストでのコミュニケーションが増えているのではないでしょうか。
弊社でも、社内のコミュニケーションは主に「Slack」を使い、チャットでやり取りしています。
メールと違って、挨拶を省いて端的に伝えたり、絵文字を使ってポップで可愛く伝えることもあります。
2. ユーザーマニュアルの作成
ユーザーが操作を迷わないよう簡潔で正確な文章が求められます。
ユーザーマニュアル作成時のポイントを、いくつか紹介します。
「読み手」と「目的」を想定する
誰がどのような場面でマニュアルを読むのかを、想定しましょう。
一般ユーザー向けの内容なのか、IT管理者向けの内容なのかによっても、表現が異なると思います。
読み手の目的別に、マニュアルを構成する
マニュアルの各章のタイトルも重要です。
また、読み手によってマニュアルを分けたり、章を分けたりすることも重要です。
管理者権限のないユーザーに、管理者権限で表示される機能の説明をしてしまい、
「マニュアルに記載されているマークが出てこない」と思われる場合もあります。
「どんな場面でマニュアルを読むのか？」を意識した上で、マニュアルを構成しましょう。
「参考情報」や「注意文」など、情報の要素を分けて書く
手順の説明途中で参考情報を入れたりすると、読者が混乱します。情報の「要素」を分けて記載しましょう。
マニュアルの場合は、「概要、手順、参考情報、注意文」などの要素で分けることができます。
また、注意文は「〇〇しないでください。〇〇のためです。」など、
具体的にやってはいけない行動とその理由を明記し、分かりやすく目立つように記載しましょう。
3. 障害報告書の作成
分かりやすく書く
「障害内容、障害原因、再発防止策」を整理して、分かりやすく書きましょう。
主担当者以外にも伝わるように書く
大規模なシステム障害の場合などの場合、主担当者の上長や、経営層などが障害報告書を読む場合もあります。
機能の名称を省略したり、専門用語を多用しすぎない説明を心掛けましょう。
言い訳や、責任逃れと受け取られるような説明は避ける
「担当者のオペレーションミスです。担当者を厳しく指導します。」など、個人を悪者にする表現は避けます。
この場合は「オペレーションミスの発生を抑止する仕組み」についての再発防止策を検討し、記載します。
また、「〇〇社の製品のバグでした」といった表現も注意です。
障害発生の直接的な原因だったとしても、この説明では「今後も他社製品のバグがあったらシステム障害が起こる」ということになります。
「モニタリングで検知し、すぐに対処できる仕組みを作る」など、社内で対策出来ることを検討し、記載します。
利用者に「対策が取られたので、これからも安心して利用できそうだな」と思ってもらえる対応策を検討して、記載しましょう。
まとめ
テクニカルライティングは、情報を正確かつ簡潔に伝えるためのスキルです。
ビジネスパーソンとして、是非学びたいスキルではないでしょうか。
一文一義で書く、50文字程度にする、結論から書く、といった基本を押さえるだけでも、分かりやすい文章が書けるようになります。
日常のテキストコミュニケーションや、ドキュメント作成などで、積極的に活用してみてください！
おすすめ書籍
テクニカルライティング入門講座 www.shoeisha.co.jp
非常に読みやすく、入門書としておススメです。
日本語スタイルガイド 第3版
単語の具体的な表現が気になるとき、参考書として活用するのがおススメです。
さいごに
トラストバンクでは、一緒にはたらく仲間を募集しています！ www.wantedly.com
