Googleテクニカルライティング5つのポイントと魅力

Sky Handです。普段は大手メーカーに勤めつつ、Roots Lab.というコミュニティを運営したり、そこでブログ発信したり、動画編集してたり、知り合いのお手伝いでPMやライティングしてたりもします。要は何でも屋です。

最近、情報化社会の進展に伴い、技術的な情報を分かりやすく伝える「テクニカルライティング」という職業が注目されています。僕もその一端を担う人間でもあるので、今日はGoogleが公開しているテクニカルライティング教育資料「Technical Writing One」と「Technical Writing Two」を基にお話しします。

題して「Googleテクニカルライティング！5つのポイントとその魅力！」です。エンジニアやライターの方は、この分をさらっとご一読して頂き、興味をもった方がいらっしゃったらぜひ原文も見てみてください。
※このnoteも僕がドキュメントを読んだ覚書のようなものなので詳細は割愛しています。

Technical Writing  |  Google for Developers

1. 読み手目線に徹底的にこだわった簡潔で分かりやすい文章

Googleのテクニカルライティングは、読み手にとっての理解しやすさを最優先に考えています。そのため、以下の点に重点が置かれています。

• 用語の一貫性
  文書全体で用語を統一し、混乱を招かないようにしています。

• 簡潔な文章
  難しい専門用語や冗長な表現を避け、簡潔で分かりやすい文章を心がけています。

• 論理的な構成
  文章の論理的な流れを意識し、読み手が迷わないように構成されています。

• 適切な情報量
  必要最低限の情報に絞り、読み手の負担を軽減しています。

• 視覚的な要素: 図表や画像を効果的に活用し、文章の内容を補完しています。

2. 読み手のニーズに合わせた情報設計

Googleのテクニカルライティングは、単に情報を羅列するのではなく、読み手のニーズに合わせた情報設計を重要視しています。

• 対象読者の明確化
  文書の対象となる読者を明確にし、その読者にとって必要な情報と適切な表現方法を検討します。

• 段階的な情報提供
  複雑な情報を段階的に提供し、読み手の理解を深めます。

• タスクベースの見出し
  読者が実行すべきタスクに沿った見出しを設定し、情報を見つけやすくしています。

• 具体的な指示
  具体的な指示や例示を用いて、読み手の行動を明確に示します。

3. 技術文書に特化した実践的な内容

Googleのテクニカルライティングは、技術文書作成に特化した実践的な内容が特徴です。

• 図やサンプルコードの活用
  図やサンプルコードを効果的に活用し、技術的な情報を分かりやすく伝えます。

• コードコメントの書き方
  コードの理解を促進する効果的なコードコメントの書き方を解説しています。

• ユーザーマニュアルの書き方
  ユーザーマニュアル作成のポイントや具体的なテクニックを紹介しています。

• チュートリアルの作成方法
  効果的なチュートリアル作成のためのガイドラインを提供しています。

4. 継続的な改善を促進するレビュー制度

Googleのテクニカルライティングは、継続的な改善を促進するためにレビュー制度を設けています。

• 自己レビュー
  書いた文書を自分で読み返す。

• 外部レビュー
  同僚や専門家によるレビューを受けることで、客観的な視点から改善点を見つける。

• フィードバックの活用
  レビューで得られたフィードバックを活かし、文書を改善していく。

5. 誰でも習得できる体系的な学習カリキュラム

Googleのテクニカルライティングは、体系的な学習カリキュラムを提供することで、誰でも習得できるように工夫されています。

• 基礎から実践まで
  基礎的な文法や文章構成から、実践的な技術文書作成まで、段階的に学習することができます。

• 豊富な演習問題
  演習問題を通して、学んだ知識を実際に活かせるようにしています。

• 分かりやすい解説
  専門用語を解説する用語集や、理解を深めるための図表などを用意しています。

Googleテクニカルライティングを学ぶメリット

Googleテクニカルライティングを学ぶメリットは、以下の通りです。

• 技術的な情報を分かりやすく伝えられるようになる

• 読み手のニーズを理解し、それに応じた情報提供ができるようになる

• 論理的な思考力と文章力を磨くことができる

• コミュニケーション能力を高めることができる

• 技術文書作成のスキルを身につけ、キャリアアップに繋げることができる

まとめ

Googleテクニカルライティングは、読み手目線に徹底的にこだわった簡潔で分かりやすい文章、読み手のニーズに合わせた情報設計、技術文書に特化した実践的な内容、継続的な改善を促進するレビュー制度、誰でも習得できる体系的な学習カリキュラムといった特徴を持ちます。

これらの特徴から、Googleのテクニカルライティングは、技術的な情報を効果的に伝え、読み手の理解を促進するのに役立つ、非常に実践的なスキルであると言えます。

ビジネスマンにとって、文章スキルはコミュニケーション能力を高め、キャリアアップに繋げるための重要なスキルです。

Googleテクニカルライティングを学ぶことで、これらのスキルを磨き、より活躍できるビジネスマンを目指しましょう。

参考情報

• Google テクニカルライティング: https://developers.google.com/tech-writing

• テクニカルコミュニケーター協会: https://jtca.org.tw/

• テクニカルライティングの仕事: https://www.indeed.com/jobs?cgtk=09c808d8-0e8e-4e8d-ab8f-c9e9e0d9ec5f&from=careerguidepromo-US&q=tiempo%20completo