合同会社モリカワのブログ

森川敬一。CTOとして30年やってきました。集大成としてCTOを増やすという事を目標にやってます。

超重要:英語のドキュメントが読みやすくなるポイント

エンジニアとして英語のドキュメントは避けて通れません。
自分の知りたいことを検索して、日本語のページだけを選択していても情報量が少ないですし、特殊な技術な場合は、日本語の情報がない場合もあります。英語は4人に1人が話す事が出来る言語でもあり英語のドキュメントの方が量も質も豊富です。そのため、エンジニアにとっては英語を読むことは、必要なスキルとなります。

1.単語だけ読む

先ずは分かる単語だけをパラパラとでも読んでみましょう。意外に中学校レベルの単語が並んでいるパターンが多いです。読むだけであれば、意味がなんとなく分かったりします。

例えば、jupyter notebookをmacに入れたいので、pip installしたらエラーになったとしましょう。

pip install jupyter

note: This error originates from a subprocess, and is likely not a problem with pip.
 ERROR: Failed building wheel for pyzmq 
Failed to build pyzmq
ERROR: Could not build wheels for pyzmq, which is required to install pyproject.toml-based projects pip
copy

最後の

Could not build wheels for pyzmq, which is required to install pyproject.toml-based projects
copy

をコピペしてgoogleで検索してみます。

https://github.com/craigbarratt/hass-pyscript-jupyter/issues/13
が検索されました。

Hi!
I use Home Assistant on a Raspberry Pi4 .
With the following command:

pip install hass_pyscript_kernel

I get the following error:

ERROR: Could not build wheels for pyzmq which use PEP 517 and cannot be installed directly

Thanks to those who will be able to provide me with support
copy

use -> 使ってる
Home Assistant -> ホームアシスタント
Raspberry -> ラズパイ
get -> 得た
following error -> 次のエラー
なんか読めそうですよね。

2.ちょっとずつ読んでいく

エラー情報だけだとなんとなく単語でもやっていけそうですが、ドキュメントの場合は結構大変そうだし、嫌悪感も感じます。
Vert.xというJavaで非同期処理が行えるフレームワークがあります。node.jsのjava版みたいな感じです。
このVert.xほとんど日本語ドキュメントがありません。

https://vertx.io/


いきなり英語バンバンですw

先ずは、チュートリアルがありそうなので探すと、STARTの中にGet Startedがありました。
ここを開くと、

In this guide, you’ll learn how to get started with a new Vert.x Web project.

Be­fore start­ing, you need:

JDK 1.8 or higher
A text ed­i­tor or IDE
Maven 3 or higher
curl or HTTPie or a browser to per­form HTTP re­quests
copy

始める前にJDK1.8以上、エディタ、Maven3以上、curl or HTTPieとかいるらしい。

次に進むと、

Choose the ver­sion of Vert.x you want to use, choose Java as the lan­guage, Maven as the build tool, and type the group id and ar­ti­fact id you want. Then, add Vert.x Web as a de­pen­dency by typ­ing it in the “De­pen­den­cies” text box. When you’re done, hit the Gen­er­ate Project but­ton. Save the zip on your com­puter and unzip it in a folder of your choice.

The gen­er­ated project con­tains:

The Maven build de­scrip­tor pom.xml con­fig­ured to build and run your ap­pli­ca­tion
A sam­ple Ver­ti­cle and a sam­ple test using JUnit 5
An ed­i­tor con­fig­u­ra­tion to en­force code style
A Git con­fig­u­ra­tion to ig­nore files
If you want to try it now, you can down­load this sam­ple project using Maven or using Gra­dle.
copy

ちょっと長いですが、単語読んでいけば読めそうじゃないですか?

Choose the ver­sion of Vert.x you want to use, choose Java as the lan­guage,
copy

Vert.xのあなたの使いたいバージョンを選んでください。Javaの言語も選んでください。

 Maven as the build tool, and type the group id and ar­ti­fact id you want. 
copy

Maveは、ビルドツールとして、あなたの欲しい、the group id and ar­ti­fact idをtypeします。

Then, add Vert.x Web as a de­pen­dency by typ­ing it in the “De­pen­den­cies” text box. 
copy

依存関係テキストボックスにtypeして、Vert.xの依存関係を追加します。

少しずつなら、なんとか読めてきます。

最後は、google翻訳

少しずつ読むと時間がかかります。面倒くさいなってきたら、一気にgoogle翻訳使いましょう。
ただ、読むにつれて慣れてきて、英語が読める様になってきます。
・嫌悪・抵抗感がへる
・言い回しのパターンに慣れてくる
google翻訳だと微妙にニュアンスが違ったり、コピペで時間も掛かります。慣れていければ良いですね。
何事も繰り返しの努力ですね。頑張って英語読んでいきましょう!

  •