テクニカルライティング【ドキュメント】

Googleテクニカルライティング講座【ドキュメント編】まとめ（日本語要約）

原文：Technical Writing One - Documents
本記事はGoogleが提供する英語のテクニカルライティング教材「Technical Writing One」より、「Documents（文書構成）」に関するセクションを日本語で要約したものです。

1. 文書全体の構成が重要

• 文が明確でも、文書全体の流れが悪いと読みにくい。
• 技術文書では、文・段落・セクションすべてに構造が必要。

2. 明確なタイトルをつける

• 読者が文書の内容を一目で把握できるようにする。
• 曖昧な表現を避け、具体的で目的が伝わるタイトルをつける。

悪い例：

• 「概要」

良い例：

• 「認証APIの導入手順」

3. 概要（導入部）を書く

• 文書の冒頭で「この文書では何を説明するのか」を明示する。
• 読者にとってのメリットや前提知識も簡潔に述べる。

例：

このガイドでは、OAuth認証を使ったログイン機能の実装方法について説明します。

4. 情報は「逆三角形型」に並べる

• 重要な情報を最初に、詳細は後に。
• 読者は全体を読まない前提で、先に要点を伝える構成が望ましい。

5. セクションと見出しを活用する

• 長文は、セクションごとに分けて整理する。
• 各セクションには明確な見出しをつけて、読者が必要な情報を探しやすくする。

6. 文書構成のテンプレート（一般的な構成）

1. タイトル
2. 概要（導入）
3. 前提条件（必要な知識・環境など）
4. 主な内容（手順や説明）
5. 補足情報（注意点、よくある質問など）

7. 一貫した構成スタイルを保つ

• セクションごとのパターンを統一することで、読者が迷わず読み進められる。
• 複数の文書間でも、フォーマットや語調の統一を心がける。

まとめ

• 明確な構成は「読みやすさ」と「理解の速さ」に直結する
• 文書全体を通して、タイトル → 概要 → 詳細の流れを意識する
• 読者が必要な情報にすぐアクセスできるように、見出しやセクションを活用する
• 書く内容だけでなく、「どの順番で、どう見せるか」を意識して構成することが重要