BOXIL 開発に携わっている、新卒エンジニアの高砂と申します。
本記事では、12月21日に弊社で開催された「テクニカルライティング研修」について紹介します！
テクニカルライティング： 情報を正確かつ効果的に伝達する文書作成技法のこと。狭義では専門分野における技術者向けの文書を対象としており、この記事内では狭義を指す。
今回の研修の主な目的は、この弊社エンジニアブログ（以下「弊ブログ」という）の記事クオリティ向上です。
そのため、普段このブログを執筆しているエンジニアを中心とした12名が参加しました！
研修の講師は、サイボウズ株式会社のプロダクトライター（製品のヘルプ等の執筆者）である殿岡理恵（@txdriet）さんが引き受けてくださりました。
当日の流れ
研修は全体で約4時間でした。内容は以下の通りです。
- 自己紹介
- 主語と述語の話
- 文章の長さと並べかた
- 構成とタイトル
- 読みかたを考えさせないために
- 読者の前提知識への配慮
- ライターが繰り返しやっていること
- 間違えやすい漢字と常用漢字表
- 人間の認知能力も知っておきましょう
- ワークショップ
- 番外編：UXライティングの考えかたまとめ
研修はZoom上で行われ、各自リモートで参加しました。
座学パート
前半は、わかりやすい文章を書くための技術を座学形式で学びました。
よくある文章をもとに、改善前の書き方と改善後の書き方を比較して説明して頂き、とても理解しやすい内容でした。
【例：主語と述語の対応】
改善前：このサービスの特長は、過去に入力したデータを簡単な操作で取得できます。
改善後：このサービスの特長は、過去に入力したデータを簡単な操作で取得できることです。
ワークショップパート
後半は、100~200文字程度の文章を参加者それぞれが実際に書き換えてみるワークショップを行いました。
お題に選ばれた文章は弊ブログ記事内から抜粋されており、執筆者を中心にZoomのチャットが盛り上がっていました！
【例：「セールスチームにKPTを導入してみた」より】
【改善前】
弊社スマートキャンプのセールスチームに、開発チームで行っているKPTによる振り返りを導入してみました。
この記事では実際にKPTを導入するまでの背景と流れ、また実施してみたセールスチームからの感想を紹介いたします。
きっかけ
ある日に1日かけて、ボードメンバーとセールスチームのマネージャー数名と共に、BALES（自社サービス）の現在のアウトカムの設定・ターゲットの詳細化・仮説の設定などを行うMTGでファシリテーターをさせていただく機会がありました。
ディスカッションの準備から関わらせてもらったため、参加されてた方からは「フレームワークを使いふわっとしたことを整理するのが得意な人」と認識していただき、別の議題について相談していただいたのがKPT導入のきっかけとなりました。
【改善後】
弊社スマートキャンプのセールスチームで、KPTによる振り返りを導入してみました。
「KPT」とはKeep/Problem/Tryの略で、振り返りのメソッドの一つです。プロジェクトの中での取り組みや進め方に対して「Keep＝よかったこと」「Problem＝悪かったこと」「Try＝次に試すこと」についてそれぞれ考えていきます。弊社では、開発チームですでに導入しているメソッドです。
この記事では、セールスチームにKPTを導入するまでの背景と流れ、また実際に導入してみての感想を紹介します。
きっかけ
XX月ごろ、BALES（自社サービス）のミーティングで、私と他の数名でファシリテーターをする機会がありました。このミーティングでは、現在のアウトカムと仮説の設定、ターゲットの詳細化などを行い、私はディスカッションの準備から関わることになりました。
これを通して、私は参加者から「フレームワークを使い、ふわっとしたことを整理するのが得意な人」と認識されることになり、その後別の議題についても相談してもらったことがきっかけで、KPTを導入することになりました。
おわりに
研修の事後アンケートではこのような意見が寄せられており、参加者の満足度が非常に高かったことが分かりました！
「記事を分かりやすく書くコツを具体的に教えてくださり、執筆の参考にとてもなりました。」
「今後エンジニアブログを書く上で、意識したい内容が盛り沢山でした。人間の認知能力に基づいた読み手のストレス耐性の話はとても興味深かったです。」
「社内にプロダクト寄りのライティングノウハウをもつ人物がいないため、今回の研修はとても勉強になりました。研修の内容もひとつひとつがわかりやすく、頭に入ってきやすかったです。」
「テクニカルライティングで本日伺ったスキルや考え方などは、テックブログへの応用はもちろんですが、Slackやメールなどのリモートでのテキストコミュニケーションが増えた現状でのどこでも利用できる素養として学ぶことができ、大変感謝しております。」
弊社では今後もこういった取り組みを通して、チーム全体でのスキル向上に取り組んでいきます！
