見出し画像

技術系ドキュメントは英語の方が分かりやすいかも?


適用範囲について

何でも英語の方が分かりやすいと主張したいのではなく、特定の分野(ソフトウェア開発や工学の分野で広く用いられる英語のAPIドキュメントや仕様書)の場合です。

ドキュメントの特徴(個人的の見解)

日本語のドキュメントは国内向けに最適化されている一方で、英語のドキュメントはより広範なオーディエンスにアプローチするためのグローバルな視点を提供します。そのため、英語の方が多くの場合、技術系ドキュメントにおいては分かりやすいと思います。

英語は主語が明記されているので、パキっと意味が通るような感じがします。一方で日本語の文章で主語が書かれていないことや、指示語を多用することが多いので、フワッとしているような感じがします。

日本語でのドキュメント

  • 特徴: ローカライズされており、その文化や特有の専門用語が反映されている。明言を避けるような、やわらかい表現。

  • 対象: 主に日本国内の技術者や専門家。日本国外の読者が理解するには、その文化や言語に精通している必要がある。

英語でのドキュメント

  • 特徴: グローバル化されており、多様な背景を持つ読者に対応している。英語は国際的な共通言語として機能し、技術的な情報の交流を促進している。

  • 対象: 世界中の技術者や専門家。異なる国籍の人々が共有しやすい形式で書かれている。

具体例:Dockerイメージについての説明

説明されている内容は全く同じなので、どちらが分かりやすいかは人によります。

まず個人的に、1文目の「read-only」と「読み込み専用」とでは、前者の方がシステム開発で頻繁に目にする機会が多いので、そのままの方が読みやすいと感じます。

特にフワっとしていると感じる部分は、「イメージは作ろうと思えば作ることができ、他の方が作ってレジストリに公開されているイメージを使うということもできます。」ですね。助動詞"might"が入ると日本語にしづらいですよね。

You might create your own images or you might only use those created by others and published in a registry.

原文が”can”を使っていないので「これからは、自分専用のDockerイメージを作るか、他の人が作ったDockerイメージを利用することになります。」って感じだと思います。"your own"ってとても重要な気がします。日本語は全てまとめて”イメージ”って言い換えてますね。主語の説明が少ない。

英語版Doc

Images
An image is a read-only template with instructions for creating a Docker container. Often, an image is based on another image, with some additional customization. For example, you may build an image which is based on the ubuntu image, but installs the Apache web server and your application, as well as the configuration details needed to make your application run.

You might create your own images or you might only use those created by others and published in a registry. To build your own image, you create a Dockerfile with a simple syntax for defining the steps needed to create the image and run it. Each instruction in a Dockerfile creates a layer in the image. When you change the Dockerfile and rebuild the image, only those layers which have changed are rebuilt. This is part of what makes images so lightweight, small, and fast, when compared to other virtualization technologies.

https://docs.docker.com/get-started/overview/

要点を抽出(GPT-4)

ChatGPTはどのように解釈するのか調べてみました。
簡単なプロンプトではグラフ化はあまり意味がありませんでした。

無言語に変換してその関係性をグラフ化して表示してください。途中経過も出力します。
1.無言語に変換し、箇条書きで出力。
2.要素を関係性に基づいて視覚的なグラフを構築し出力(グラフの表記は英語、Pythonで作成)
[このあとに文を挿入]
  1. Dockerコンテナを作成するためのテンプレート。

  2. 他のイメージに基づいてカスタマイズされることが多い。

  3. Ubuntuイメージを基に、Apacheウェブサーバーとアプリケーションをインストール。

  4. アプリケーションを実行するための設定詳細が含まれる。

  5. 自分でイメージを作成する場合、Dockerfileを使用。

  6. Dockerfileにはイメージ作成と実行の手順を定義する簡単な構文がある。

  7. Dockerfileの各指示はイメージのレイヤーを作成する。

  8. Dockerfileを変更してイメージを再ビルドすると、変更されたレイヤーのみが再ビルドされる。

  9. イメージが他の仮想化技術に比べて軽量で小さく、速い。

GPT-4によるグラフ化(英語)

日本語版Doc

イメージ
イメージ( image )とは、Docker コンテナを作成する命令が入った読み込み専用のテンプレートです。通常イメージは、他のイメージをベースにしてそれをカスタマイズして利用します。たとえば ubuntu イメージをベースとするイメージを作ったとします。そこには Apache ウェブ・サーバや自開発したアプリケーションといったものをインストールするかもしれません。さらにアプリケーション実行に必要となる詳細な設定も加えることにもなるでしょう。

イメージは作ろうと思えば作ることができ、他の方が作ってレジストリに公開されているイメージを使うということもできます。イメージを自分で作る場合は Dockerfile というファイルを生成します。このファイルの文法は単純なものであり、そこにはイメージを生成して実行するまでの手順が定義されます。Dockerfile 内の個々の命令ごとに、イメージ内にはレイヤというものが生成されます。Dockerfile の内容を書き換えたことでイメージが再構築されるときには、変更がかかったレイヤのみが再生成されます。他の仮想化技術に比べて Dockerイメージというものが軽量、小さい、早いを実現できているのも、そういった部分があるからです。

https://docs.docker.jp/get-started/overview.html

要点を抽出(GPT-4)

同じように、日本語でも試しました。

  1. Dockerイメージは、コンテナを作成するための読み込み専用テンプレートです。

  2. イメージは、他のイメージをベースにカスタマイズして使用します。

    • 例:Ubuntuイメージをベースに、Apacheウェブサーバーや自開発アプリケーションを追加。

  3. Dockerfileによってカスタマイズされ、その文法は単純です。

    • Dockerfileはイメージ生成と実行の手順を定義。

  4. Dockerfileの各命令はイメージ内でレイヤを生成。

    • レイヤはDockerfileの変更に応じて再生成される。

  5. Dockerイメージは軽量で、速度が速い。


GPT-4によるグラフ化(日本語)



この記事が気に入ったらサポートをしてみませんか?