コンテンツにスキップ
DevGlish Docs

英語の技術ドキュメントを読む

英語ドキュメントを読む際の課題

Section titled “英語ドキュメントを読む際の課題”

非ネイティブの開発者が英語の技術ドキュメントを読む際のよくある問題：

  • 段落全体が理解できず、1 文ずつ翻訳する必要がある
  • なじみのない表現に出会うたびに辞書を引き、ワークフローが中断される
  • 読み終わっても忘れてしまう、または表現を覚えたが使えない
  • ドキュメントの例文は良いが学べない（保存する場所がない）

3 つのワークフロー

Section titled “3 つのワークフロー”

ワークフロー 1: クイック単語検索（作業を中断しない）

Section titled “ワークフロー 1: クイック単語検索（作業を中断しない）”

ドキュメントを読んでいてなじみのないフレーズに出会い、すばやく理解したいが中断したくない場合。

Reading: "This design pattern leverages polymorphism
to achieve decoupling between layers."


遭遇: "leverages" — クイック単語検索

操作：

  1. “leverages” を選択
  2. ⌘⇧D（グローバルショートカット）を押す
  3. DevGlish のフローティングウィンドウが表示され、定義と発音を表示
  4. 一度読み、閉じる（⌘W）
  5. ドキュメントを読み続ける

ワークフロー 2: 段落モード（深い理解）

Section titled “ワークフロー 2: 段落モード（深い理解）”

段落全体が理解できず、1 文ずつ分解する必要がある場合。

操作：

  1. 段落全体をコピー
  2. DevGlish 段落モードを開く（メニュー → Paragraph Mode）
  3. テキストを貼り付け
  4. Claude による文ごとの分解を確認

ワークフロー 3: 質の高い表現を保存する（ライブラリの蓄積）

Section titled “ワークフロー 3: 質の高い表現を保存する（ライブラリの蓄積）”

ドキュメントを読む過程で、良い表現方法を見つけた場合。保存して、後で自分のコードレビューやドキュメントで使用できます。

操作：

  1. その文を選択
  2. ⌘⇧D で DevGlish を開く
  3. 「保存」ボタンをクリック
  4. “technical-writing” や “kubernetes” などのタグを付ける

後で PR や技術ドキュメントを書く際に、このタグを検索して表現を再利用またはアレンジできます。

ドキュメント読解のベストプラクティス

Section titled “ドキュメント読解のベストプラクティス”

1. まず理解してからコードを深掘り

Section titled “1. まず理解してからコードを深掘り”

複雑な概念に遭遇した場合：

  1. 段落モードでドキュメントの説明を理解
  2. 概念を読み終えてからコード例を見る
  3. まだ不明な場合は YouTube の解説動画を検索

2. アクティブ語彙ライブラリ（Active Vocabulary）

Section titled “2. アクティブ語彙ライブラリ（Active Vocabulary）”

表現に出会ったときの 3 つの選択肢：

処理方法シーン例
クイック検索（保存しない）理解できればよい、短期間では使わない”parameterize”（パラメータ化する）
保存するが復習しない良い表現、後で使うかもしれない”achieves decoupling”（デカップリングを達成する）
保存 + 復習よく使う、能動的にマスターする必要がある”race condition”（競合状態）

3. ドキュメントの種類に応じて戦略を調整

Section titled “3. ドキュメントの種類に応じて戦略を調整”
ドキュメントの種類読み方いつ保存するか
API ドキュメントすばやくスキャン、なじみのない語を検索パラメータの説明、よくある用法
チュートリアル段落モードで 1 文ずつ理解良い説明文、例文
設計ドキュメント概念に集中、詳細は無視アーキテクチャの記述、設計のトレードオフの説明
ブログ記事段落全体を読み、曖昧なところだけ段落モード意見の表現、ベストプラクティスの表現

段階的な読解レベルの向上

Section titled “段階的な読解レベルの向上”

第 1 段階：簡単なドキュメント（入門レベル）

Section titled “第 1 段階：簡単なドキュメント（入門レベル）”
  • Django のビギナーチュートリアル
  • 公式 API 入門ガイド
  • 中程度の難易度のブログ記事

戦略： クイック検索 + たまに段落モード

保存率： 新しい表現の 5〜10%

第 2 段階：中程度の難易度のドキュメント

Section titled “第 2 段階：中程度の難易度のドキュメント”
  • Kubernetes の公式ドキュメント
  • 大規模オープンソースプロジェクトの設計ドキュメント
  • 高品質な技術ブログ

戦略： 複雑な文は段落モード、なじみのない概念も段落モード

保存率： 新しい表現の 15〜20%

第 3 段階：高難易度のドキュメント

Section titled “第 3 段階：高難易度のドキュメント”
  • 学術論文（あなたの分野に関連するもの）
  • 複雑な RFC（Request For Comments）
  • 詳細な技術分析

戦略： まず日本語の要約や解説動画を見て、それから原文を読み、段落モードで各段落を処理

保存率： 新しい表現の 20〜30%（すべて価値の高いもの）

ドキュメント読解の時間配分

Section titled “ドキュメント読解の時間配分”

技術ドキュメントを読む際の時間配分：

  • 50% — 主要な概念の理解（クイック検索、段落モード）
  • 30% — コード例を読み、実際にやってみる
  • 20% — 質の高い表現を保存し、単語帳に追加

個々の表現に時間をかけすぎないでください。「80% 理解できれば」先に進みましょう。100% 完璧な理解を追求しないでください。