国内テック企業から学ぶテクニカル・ライティング

テクニカル・ライティング -
ユーザーに分かりやすく技術の内容を伝える文章。

ここ最近、テクニカル・ライティングが熱い！！（個人比）
noteで文章術について検索していると、テクニカル・ライティングの記事をしばしば見かけます。
ITシステムが大規模化・複雑化していくにつれ、仕様を分かりやすく内外に伝える重要性は増すばかり。テクニカル・ライティングの名前を冠した国内試験もあり、注目度の高さが伺えます。

月に一度、さまざまな文章術についての学習を発信しています。
今回は「分かりやすく専門的な知識を届ける文章術」ーテクニカル・ライティングについての基礎をご紹介します。
大手のテック企業では、テクニカル・ライティングを研修に取り込むことも、ままあるようで、国内テック企業の発信をまとめてみました！

◼︎サイボウズ株式会社 （参照記事URL）

テクニカルライティングのサジェストに載っていたので気になり見てみました。新人研修会で使われているプレゼン資料が公開されており、これがめちゃくちゃ読みやすい！
資料作成者の仲田尚央さんは、教育の場でも活動されているらしく、さすが教えることに長けているなと感じました。
要点は以下です。

テクニカル・ライティングとは？

それは、「読者や目的に合わせて技術をわかりやすく伝える手法」。ライティング手法が上達すれば、自他の情報共有を効率化していける。

技術書の基本性質

• 求めている情報が人により異なる

• 情報の探し方も人により異なる（知りたいことが明確/曖昧）

• 一意に伝わる必要がある

• 一部しか読まれない

↓　以下の要素を備えた文章を心がける

• Effectiveness(効果): 曖昧さを排して具体的に

• Efficiency(効率): 構造化して、重要なことから簡潔に、必要なだけ

• Satisfaction(満足): 肯定的な表現で、丁寧に

情報を整理する

概要から具体 or 全体から部分。これが鉄則。
読者の期待に合わせて情報を整理することで、ユーザービリティが高くなる。
同じ階層では同じルールで章を立てる。（章の内部は独自のルール/整理でもよい）。
各章のタイトル（アウトライン）は、それを見るだけで情報を読み取れる言葉にする。

簡潔な文章で

• 一文一義

• 読者視点

  • 例：登録していただいた方にお送りします → 登録すると受け取れます

  • 例：リセットされるとデータを削除します → リセットするとデータが削除されます

• 肯定形で

  • 例：アップデートを放置しないでください → アップデートは早めに適用してください

  • 例：5名以上の予約は受付られません →4名まで予約できます

◼︎LINEヤフー株式会社 （参照記事URL）

テクニカルライティング × 企業 で、真っ先に思い浮かんだのが、実はLINE株式会社（2020年6月当時）の掲題の記事。当時から専門チームが用意され、「わかりやすい技術書」への意識を高められていたらしく、そのエッセンスがまとめられた記事は、大きく注目を集めました。
「いい文章を書けるとは、いい文章を選択できること。文章のバリエーションを素早く作ることを心がけた。」という、新鮮な切り口で始まる文章術。その要点を、以下にまとめます。

タイトルを意識する

分かりにくさとは、読み手の期待と書き手の伝えたいことのズレからも発生する。タイトルでそのズレを減らしていく。文頭で本文の結論を示したり、話題を限定したりすることで、期待値をコントロールする。

主語と述語を明らかにする

一文を読み直す際に、主語と述語が何かを考える。誰が何をしたときの文章か、明確だと文章はわかりやすい。
さらに、主語と述語の距離を近くすることで、理解しやすくなる。

文を短くする

文章が長くなると分かりにくくなる。
「ので、」「し、」がある文は分割できる。

読み方を工夫しなくてもわかる文章を書く

文章の論旨が何かを考える。情報量が増えると読み取りが難しくなる。不要な情報は削る。
文を読む際に、どのように分かりにくいかを考える。前提知識が必要な場合、読者に合わせた情報になっているかを考える。

◼︎クックパッド株式会社 （参照記事URL）

企業の技術者ブログというと、代表例として名前が上がることが多いクックパッド開発者ブログ。Rubyをはじめ、さまざまなIT分野での積極的な情報発信をされているイメージがあります。
テクニカルライティングに関しては、直接的な記事はなかったものの、ドキュメンテーションをする際の参考として、掲題の記事はリンクされていることは多かったです。内容はコンパクトですが、まとめておきます。

ドキュメントの役割

メンタルモデル：「これをするにはこうする。こうしたらこうなる。」という動作イメージを描けるようにすることがゴール。
読者が期待するメンタルモデルの類型には、次のレベルがある。

• 初めて使う人向け：とりあえずサクッとできることを知りたい

  • → クイックスタート、チュートリアルがあると便利。丁寧な内容を心がける

• 特定の使い方を探している人向け

  • → こういうことをするには？の疑問に答えられる構造化。ユースケースやサンプル集が有用

• もっと使いこなしたい人向け

  • → 網羅的な辞書やリファレンスを用意する。他のユーザーとはページの入り口を分ける

＊＊＊＊＊＊

最後までご覧いただきありがとうございました！
テクニカルライティングは、効率的に情報を伝える文章術。
情報が膨大になるいま、まさに求められるライティングスキルです。
ライティングで差をつけろ！

読みやすく構造化された記事であることは、情報発信を基本とするWebブログもまた同じ。今回のお作法をを取り入れて、よりストレスレスで呼んでもらえる文章を心がけていきます。

---

これからも週に1回、世界を広げるための記事を書いていきます！
過去のライティング研究シリーズはこちらに。
よければイイネ・フォローも！
シェア、コメントもお気軽に🤲
どうぞ、また次回！