1. はじめに
はじめまして。濵口と申します。2024/8 に CRE（Customer Reliability Engineer）として株式会社ログラス（以降、ログラス）に入社しました。
CRE の具体的な業務内容は各社各様であり、また、CRE の名前に表れる顧客信頼性の解釈もまた様々です。しかしながら、顧客信頼性に向き合うという広い観点から見ると、テクニカルライティングは CRE にとって非常に重要なスキルだと考えています。また、CRE に限らず、顧客など外部のステークホルダーに向けた文書を書く可能性があるエンジニアにとっても有用です。
本記事では、CREがなぜテクニカルライティングを重視すべきか、そしてそのスキルがどのように日々の業務に役立つのかを探っていきます。CRE とテクニカルライティングの関連について整理したい方や、テクニカルライティングに興味はあるけど取っかかりを掴めていない方に何らかの示唆をご提供できれば幸いです。
2. テクニカルライティングとは
技術的な、または複雑な内容を読み手にとって分かりやすく伝える手法です。 この定義だとかなり広く解釈することが可能なため、定義の範囲を狭め、執筆の趣旨を伝わりやすくしておきます。この記事では、弊社の業務や後述する弊社 CRE の業務内容を考慮し、BtoB SaaSにおいて、エンジニアが顧客に向けたドキュメントを分かりやすく書くための手法や心構えを指します。より具体的なドキュメントとしては、顧客に製品機能や Q&A などを案内するサポートサイト上の記事、あるいは、API ドキュメントといったものを想定しています。
3. ログラスにおけるCREとは
弊社における CRE のミッションは、以下の通りです。
顧客の信頼性を向上させるため、
顧客の課題を継続的に計測・分析し、
エンジニアリングによって信頼性向上に貢献する
より詳細な活動内容については、弊社の山﨑(@zaki___yama)が執筆したスライドをご覧いただければと思います。
4. なぜCREにとってテクニカルライティングが重要なのか
テクニカルライティングのスキルを身につけ、実践することにより、より良い顧客体験を提供して顧客信頼性を向上させることや、CRE の業務効率を向上させることが期待できます。
例えば、顧客がプロダクトを利用している際に何か不明な点に遭遇したとします。不明な点を解消するために、担当窓口に問い合わせたり、提供されているサポートサイトを参照したりするでしょう。さて、素早く自己解決したい顧客がサポートサイトを参照したとします。関連ページをすぐに見つけることができ、どうやら必要な情報は充分に用意されていそうですが、あまりにも分かりづらい文章や構成だったとしたらどうでしょうか？
時間をかけて読み込めば確かに自己解決できるかもしれませんが、とても素早いとは言えませんし、その後、サポートサイトを離れて、担当窓口に問い合わせても同様です。このとき既に、顧客の信頼は低下していることでしょう。サポートサイトの運営を管掌しているのが CRE であれば、本来の職責を果たせているどころか、反している状態になってしまっています。
一方で、サポートサイトが非常に読みやすい状態になっていることを考えてみてください。こうした環境をつくることの利点は少なくとも以下の 2 点が考えられ、いずれも CRE が注力するための理由になります。
- 顧客が自身の不安を解消するための需要を満たされている。これにより、プロダクト運営に対して負の感情をもたれることがなく、顧客信頼性が低下することはない。サポートサイトの品質を継続して向上させることにより、顧客信頼性を上げていくことも可能だと考えられる
- 顧客の自己解決率が向上するため、有人による問合せ対応の時間を削減できる。削減できた時間をプロアクティブな問合せ対応に割くことも可能になり、よりよいサイクルを回せるようになる
5. テクニカルライティングの活用
テクニカルライティングの具体的な活用先としては、前章や冒頭にも書いたサポートサイトや API ドキュメントなどが挙げられます。 これらにテクニカルライティングを適用し、積極的に顧客に案内して使っていただくことにより、前章で示した利点を得られるようになると考えられます。
弊社においてもサポートサイトを構築済みであり、すでに運用を開始しています。現在、サポートサイトをより顧客に活用していただくようにすることを目的に、サポートサイトの改善活動に取り組もうとしています。予定している内容のうち、テクニカルライティングを活かせるものとして以下があります。
- サポートサイトによる問い合わせ解決率の改善
- コンテンツの充実と並行して内容の見直しを行うことにより、顧客が更に自己解決できるようにすることを目指します。コンテンツを充実させるために新しく記事を書く際にも、内容の見直しを行う際にも、テクニカルライティングのスキルを活かして文章レベルの改善を行い、顧客にとって内容を理解しやすくします
この改善活動を通じて、テクニカルライティングをどのように活用できたのか、成果や学び、反省などを今後ブログで共有していきたいと考えています。
6. テクニカルライティングを学ぶために
幸いにも、先達の方々が既に、テクニカルライティングに関する様々なコンテンツを提供してくださっています。あるいは、コミュニティも存在します。 コンテンツを提供してくださっている企業様、あるいはコミュニティの皆様、ありがとうございます。
私が調査した範囲内ではありますが、いくつかを紹介させていただき、学ぶための手がかりになれば幸いです。
以下の記事は二年ほど前のものになりますが、テクニカルライティング関連のコンテンツを継続的に提供してくださっている企業がまとめられています。
以下のコミュニティにおいては、テクニカルライティングに関わる方々がノウハウを共有しています。
以下は LINE Developers Japan が投稿されているセミナー動画であり、非常に長時間ではありますが、様々な知見が共有されています。
7. まとめと結論
この記事を通じて、CRE にとってテクニカルライティングがいかに重要なスキルであるかを探りました。特に、顧客との信頼関係を築くうえで、わかりやすく正確なドキュメントの提供が不可欠であることを強調しました。
テクニカルライティングのスキルを継続的に学び、実践していくことにより、顧客が自己解決できる環境を整えることができます。これにより、以下の利点を得られると考えています。
- より良い顧客体験を提供でき、顧客から得られる信頼を向上させられる
- CRE の業務効率化につながる
今後、テクニカルライティングの学び、実践していく仕組みを社内で模索していき、その学びを共有できればと考えています。お読みいただきありがとうございました！
株式会社ログラスは「良い景気を作ろう。」をミッションに、企業経営を推進する次世代型経営管理クラウド「Loglass 経営管理」を開発し提供しています。
Discussion