ADXでは技術関連の社内勉強会を頻繁に行っております。今回は、「社内テクニカルライティング勉強会」と一般的な「テクニカルライティングとは何か」についての解説をいたします。
テクニカルライティングを学ぶこと
「テクニカルライティング」という言葉を聞いたことのある方も多いと思います。イメージとして理解していても、実際にどういうものかを文章で説明できる方は少ないのではないでしょうか。「技術者が文章でシステムを説明するために書くテキスト」と単語そのままを翻訳する意味で捉えてももちろん間違いではありません。しかし、どういうものなのかをもう少し踏み込んで学ぶことをお薦めします。ここを理解して「テクニカルライティング」として文章を作成すると、わかりやすさ、読みやすさ、伝わりやすさが格段に向上します。結果としてコミュニケーション能力が向上し、ビジネス上でプラスに働くことも多くなります。テクニカルライティングは訓練で誰でも身につけることのできる技術なのです。
勉強会の開催
今回の「テクニカルライティング勉強会」は、通常の勉強会とは少し異なる雰囲気で開催されました。通常は「新システムを試用した技術者
がシステムの概要や使用状況、作成手順、ダミーデータ、画面展開を見せて説明」、「ベテラン技術者が過去案件のシステム概要や使用方法、状況を説明」、「システム仕様変更に伴う注意点を共有するための勉強会」などが開催されます。技術の知識を保持するスタッフが持たないスタッフに伝えるイメージです。今回はメンバーが「テクニカルライティングに起因するコミュニケーション」問題をとりあげ、失敗例の共有を行いました。「今後、同様の失敗を避けるためにどのような点を注意したらいいか」、「今後の業務にどう活かしていくか」という内容の勉強会でした。
最も大切なことは理解されること
芸術的な文芸作品や行間を読む随筆とは異なり、テクニカルライティングにもっとも要求されるのは「理解」される文章であることです。文章を読む対象が、利用者である読者と限定されるため文章作成には才能やセンスではなく、技術が要求されます。「誰に」「何を」「どのように」伝えるのかは訓練によって誰でも身につけられるようなります。
テクニカルライティングとは何か
テクニカルライティングとは、「モノやコト（概念）を伝える説明技術の一つ」と定義されています。専門家が作成した技術的な内容を使用者（利用者）に伝わりやすくする理解させる文章を指します。電化製品を購入した時に添付されるマニュアルは「使用者にわかりやすく伝える技術テキスト」です。弊社の場合システムを扱うので「専門的な内容を誤解なく読み手に伝える表現技法」になります。ここで言う「誤解なく読み手に伝える」技術は書くだけでなくビジネス全般に有効にはたらきます。
顧客対応や会話において生じる、言葉の取り違いや認識の温度差が後日大きな問題になることはないでしょうか。認識の差から後日生じる、訂正・修正で工数をかけてしまうことは。テクニカルライティングで習得する「誤解なく読み手に伝える」技術は、誤解をなくすことにもつながるのです。
テクニカルライティングチェック項目
弊社が実際に使用するテクニカルライティングのチェックシートは以下の9項目です。
- 冒頭に概要を書いているか
- 一文一義で書いているか
- 読者の視点で書いているか
- 重要なことから書いているか
- 文はこれ以上短くならないか
- 曖昧な表現はないか
- 係り受けは明確か
- 否定形は肯定形で書けないか
- 修飾する側とされる側が離れすぎていないか
現在はこの9項目で運用されていますが、勉強会の進行によりこの内容は追加・変更・削除が頻繁に行われていきます。
具体的な失敗例の共有
今回のプレゼンテーターから失敗の具体例が紹介されました。「失敗」後の「改善」が紹介され、学んだことも追記されます。
失敗① 読み手の視点・状況の想像不足
お客さまへの連絡テキスト
失敗例
テスト仕様書をご確認いただいた後、受け入れテストを行っていただき、不備・疑問がある場合はエクセルへの記載をお願いいたします。
修正例
テスト仕様書（資料名、URL）をご確認いただいた後、受け入れテストを行っていただき、不備・疑問がある場合はエクセルへの（資料名、URL）記載をお願いいたします。
学んだこと
会議不参加の方にも理解していただけるように、具体的な資料名、URLを追加する。読み手がすべて会議参加者とは限らない、読み手の視点と状況を想像する必要性を認識。
失敗② 目的語・主語の省略
打ち合わせ議事録より
失敗例
帳票授受の際、返却物が提出無しだと困るため制限が必要。社内で整理を行う。
修正例
帳票授受の際、返却物が提出無しだと困るため制限が必要。対象帳票については社内で整理を行う。
学んだこと
主語、目的語を明確にする。「誰」が「何」を「どうする」のか。短いセンテンスで全て記述されているか確認する。
失敗③ 冗長なテキスト
打ち合わせ議事録より
失敗例
・製品種別が一般ユーザー以外の場合、種類名称項目は必須となるようにチェックを追加する。製品種別が一般ユーザー以外の場合エラーにすることも可能だが、その対応は必要か？（A様）
・エラー表示希望（B様）
・承知、以下対応を行う（C様）
１．一般ユーザー以外の場合、種類名称項目は必須とする。
２．一般ユーザーの場合、種類名称項目を入力できないようにする。
修正例
・製品種別が一般ユーザー以外の場合、種類名称項目は必須となるように以下のチェックを追加する。（A様）
・エラー表示希望（B様）
・承知、以下対応を行う（C様）
学んだこと
議事録作成時は会議で話したことをそのまま記載するのではなく要点をまとめて書く。
テクニカルライティング取り組み後の変化
勉強会の最後にプレゼンテーターより「テクニカルライティングを学び、自分や業務がどのように変化したか」説明がありました。弊社の場合フルリモート業務のため対面とは異なる工夫が必要です。画面上でのやりとりやテキストでの意思伝達になるため理解に過不足がないよう細心の注意をはらいます。テキストによるコミュニケーションが多い中で「自分が伝えたいことは何か、それを伝えた相手がどう動くのが理想か」を「考えるクセがつき、意識するようになった」と説明がありました。また、意識することでテキストがシェイプアップされ、やり取りが「スムーズかつ最小限」になり、効果が実感できているとも。
現在は「課題についての不明点をうかがう時」や「現状の進捗状況を伝える時」に利用することが当たり前になっている様子でした。現状はテキストでのやり取りに使用しているテクニカルライティングですが、その技術をもっと広範囲にとらえ、業務で使用する口頭での会話に応用していきたいと熱く抱負を語って勉強会は終了しました。
まとめ
お客様の業績をアップさせるためにシステムを導入することが弊社のメイン業務です。お客さまに提示するテキストを具体的でわかりやすいものにすることで、お客さまが文章を読み理解する時間を短縮させ、本来業務に集中する時間を少しでも多く確保することもコンサルタントとしての使命だと思っております。「後世に残したい失敗」をスタッフ間で教共有することで基礎力を底上げし、お客様に貢献できるよう会社として務めてまいります。
最後に、弊社にはSalesforceのスペシャリストが多数在籍しております。
何かお困りごとがございましたら、下記ボタンからお気軽にご相談くださいませ。
お問い合わせはこちら
当社内でのテクニカルライティングの学習・普及活動には、サイボウズ様の以下公開資料を活用させていただいております。
2023年のエンジニア新人研修の講義資料を公開しました
テクニカルライティングの基本 2023年版 – Speaker Deck