エンジニアが身につけておくべきテクニカルライティングスキル

エンジニアはコードを書くだけが仕事ではありません。仕様書などの技術的なことを書くテクニカルライティングが必要です。

長い文章を書こうとするとつい「才能」に逃げてしまいそうになりますが、テクニカルライティングは「技術」さえあれば誰でもできます。

今回はエンジニアにとって避けては通れない技術であるテクニカルライティングを無料で学べる「Googleテクニカルライティング」を解説します。

文章を書くのが苦手な方は必見です。

Googleテクニカルライティングはエンジニア初学者にオススメのテクニカルライティングスクール

画像引用：Googleテクニカルライティング

Googleテクニカルライティングは、Googleが無料で提供するテクニカルライティングスクールです。基礎から実践まで幅広く学べるため、ライティングが苦手なエンジニアはもちろん、初学者の方でも安心して受講できます。

そんなGoogleテクニカルライティングを受講するにあたって、まずは以下の項目を知っておきましょう。

• テクニカルライティングが必要なエンジニアは多い
• テクニカルライティングの教育用資料がわかりやすい
• コンテンツが豊富
• 対象者は3種類

テクニカルライティングが必要なエンジニアは多い

エンジニアにとって、テクニカルライティングを求められる機会は多々あります。仕様書の作成は、その最たる物です。

以前は長い文章を書くことが多くありましたが、近年は技術的な進歩もあって長い文章をほとんど書かなくなっています。SlackやTwitterなど、良く使うツールでは短文が基本となり、長文はあまり使われません。

そのため、「長文で相手に伝わりやすい文章を書く能力」に自信の無いエンジニアが増えています。

ですがテクニカルライティングを求められる場面は多く、エンジニアのスキルとして身につけておく方がメリットが大きいと言えます。

テクニカルライティングの教育用資料がわかりやすい

Googleテクニカルライティングの教育用資料は、わかりやすく作成されています。多少の英語のライティング能力は問われるものの、優れたライターである必要がないと明言されていることからも姿勢がわかります。

学ぶ内容も文章の基礎部分からなので、学校で国語を勉強してこなかった方でも理解しやすい内容です。

そのため、テクニカルライターとして羽ばたくために必要な基礎をしっかり学べる、優れた教育用資料として活用できます。

コンテンツが豊富

Googleテクニカルライティングは、コンテンツが豊富に用意されています。テクニカルライティングが苦手なエンジニアの方でも、気軽に取り込めるでしょう。

コンテンツは以下の4種類に分かれており、まずは自分で学びます。

• 事前学習用：1～2時間
• 講義（実践学習）：2～2.5時間
• アクセシビリティのためのテクニカルライティング：1.5時間
• 役立つエラーメッセージの作成：1.5時間

「独学で予習してから講義に参加する」形です。長時間の勉強も必要なく、隙間時間を使って学べる量となっています。

コンテンツが豊富でありながらしっかり学べる点は、Googleテクニカルライティングの特徴と言えます。

対象者は3種類

Googleテクニカルライティングが対象としているエンジニアは、3種類に分かれます。以下の役割を持つ方達です。

• プロのソフトウェアエンジニア
• コンピューターサイエンスの学生
• プロダクトマネージャーなどエンジニアリングに関連する役割

これらからも分かるように、専門家である必要はありません。求められているとすれば、少々の英語力とコーディングの経験くらいです。

上記の3つのどれかに当てはまるのであれば、ぜひ受講することをオススメします。

Googleテクニカルライティングの内容

Googleテクニカルライティングの内容は、2つに分かれています。ここからは受講項目別に分けて解説します。

注意点として、受講する際は、まず基礎的な内容である「Technical Writing One」の方からにしましょう。いきなり難易度を上げるとわからなくなるためです。

• Technical Writing One
• Technical Writing Two

Technical Writing One

画像引用：Googleテクニカルライティング

「Technical Writing One」は、テクニカルライティングの基礎を学ぶコースです。初学者の方にもオススメですが、既にテクニカルライティングを学んだ方でも復習として活用できます。

教材は以下で構成されています。

• 表記揺れについて
• 曖昧な代名詞を避ける
• 受動態と能動態の違い
• 強い動詞を使う
• 曖昧な動詞よりも意味が限定される動詞を使う
• 一文一義
• 長い文章はリスト形式で表記する
• 不要な言葉を排除する
• リストの使い方
• リストと表を適切に使う。
• 段落の骨子になるリード文の作り方
• 1段落1トピックで作る
• 読み手に伝えるべき内容を定義する
• 読み手を意識して書く
• ドキュメントの最初に重要なポイントを示す
• カンマや括弧などの使い方

どれもテクニカルライティングにおいて基礎的なものばかりです。習熟するとライティング全般で活用できる内容なので、履修をオススメします。

Technical Writing Two

画像引用：Googleテクニカルライティング

「Technical Writing Two」は、「Technical Writing One」を修了した上で、更に技術を向上したい方向けに提供されているコースです。内容もそれに準じたものとなっています。

• テンプレートを使う
• 読み手がどう思うかを考える
• 書いた文章を声に出して読んでみる
• 下書きを書いた後の作業について
• ドキュメントの整理方法
• ドキュメントの対象範囲と前提条件の出し方
• 見出しの作成方法
• 情報の出し方
• イラストの作成方法
• 1つの画面内における情報量のコントロール
• 要点の説明方法
• マークの引き方
• 画像の挿入タイミング
• 理解しやすいサンプルコードの作成方法
• 例の表示方法
• 見直しの重要性
• 資料形態の選択
• 作成時の注意点

「Technical Writing One」よりも全体を俯瞰した場合のコツが多い内容です。普段何となく作っている方でも体系立てて理解を深められるでしょう。

Googleテクニカルライティングの形式

Googleテクニカルライティングは、これから学ぼうと考えているエンジニアの方にとって学びやすい形式です。1と2がありますが、両方とも以下の形式で進みます。

1. 授業前のレッスン：2～3時間
2. ファシリテーターと他の生徒によるクラスレッスン：2～2.5時間

授業前のレッスンは長いように感じますが、1つ1つの項目が10分程度と短く、隙間時間を有効的に使えます。

事前に内容の予習をできるため、理解度を深めたままレッスンに進めるのは非常に効率的です。学ぶのに最適な形式と言えるでしょう。

Googleテクニカルライティングの注意点

Googleテクニカルライティングは、エンジニアの方が1からテクニカルライティングを学ぶなら最適の教材です。ただし、全ての方にオススメできるわけではありません。特に以下の2つについては注意しましょう。

• 全て英語で書かれている
• デスクトップ用に最適化されている

全て英語で書かれている

Googleテクニカルライティングは、海外でリリースされているものです。日本でも使えますが、全て英語表記となっています。そのため最低限の英語力が必須です。

翻訳ツールを使って学習する方法もありますが、手間と翻訳性能の観点からオススメはしません。リーディング・リスニングともに求められます。英語力が必要になる点は注意しましょう。

デスクトップ用に最適化されている

Googleテクニカルライティングは、デスクトップ用に最適化されています。スマホやタブレットでも使えますが、キーボードが求められる場合もあるためオススメはしません。快適に学ぶのであれば、以下のどちらかを使いましょう。

• デスクトップパソコン
• ノートパソコン

教材の中には動画もあります。スマホやタブレットは、そうした場合に使うと効率的です。

Googleもデスクトップ環境に最適化と明言しているので、適した環境で学びましょう。

エンジニアが身につけるべきテクニカルライティングスキルはGoogleテクニカルライティングで身につけられる

エンジニアはテクニカルライティングを求められる場面が多々あります。文章を書くのが苦手でもスキルは身につけておかなければいけません。

Googleテクニカルライティングは、初心者向けに無料で提供しているテクニカルライティング講座です。基礎から応用まで幅広い内容となっているので、一通り学べば様々な場面で活用できます。

ライティングに自信のないエンジニアの方は、ぜひ1度受講してみてくださいね。