頻出英語表現(2):◯◯にあるとおり

プログラミング関連のドキュメントで頻出する英語表現を紹介します。とりわけAPIリファレンスやマニュアルでよく用いられる表現を取り上げます。


APIリファレンスやマニュアルでは、読者に別の情報を参照してもらうケースがよくあります。頻出表現の第1回では「詳細は◯◯を参照してください」という表現を紹介しました。

今回は同じく、別の情報を参照してもらいたい場合に使える「◯◯にあるとおり」という表現です。

▼ as described in …

これが最もよく見られる基本的な形です。describeは「記述する」や「説明する」という動詞です。「…」の部分に場所が示されます。例:

  • As described in the previous section, you need to change your password.
    • 前のセクションにあるとおり、お使いのパスワードを変更する必要があります。
  • Edit your profile as described in this documentation.
    • このドキュメントにあるとおりにプロフィールを編集します。

describe以外の動詞

describe以外の動詞を使うことで、表現に変化を付けたり、ニュアンスを変えたりできます。

define(定義する)、discuss(論じる)、explain(説明する)、show(見せる)、specifiy(指定する)といった動詞です。例:

  • Returns a string as defined in RFC xxx.
    • RFC xxxに定義されているような文字列を返す。
  • Add a README file as discussed in #154
    • #154で議論したとおりにREADMEファイルを追加(※コミットメッセージ)
  • Specify a destination as explained in Step 3.
    • ステップ3で説明したとおりに宛先を指定します。
  • An error dialog appears, as shown in Figure 5.
    • 図5で示すように、エラー・ダイアログが表示されます。
  • [Parameters] attrs: Attributes as defined in XML file.
    • [パラメーター]attrs:XMLファイルに定義されている属性。

in以外の前置詞や副詞

ほかの応用として、前置詞inの部分を別の言葉に置き換える方法もあります。

たとえばabove(上に、上記)、earlier(以前)、here(ここに)です。例:

  • HTTPS should be used as described above.
    • 上記のとおりHTTPSを使うことが望ましい。
  • As described earlier, user accounts cannot be deleted automatically.
    • 前述したように、ユーザー・アカウントは自動的に削除できません。
  • Our services are as described here: www.example.com.
    • 弊社サービスはここに記載されているとおりとなります: www.example.com

[筆者について]
西野竜太郎。IT分野の英語翻訳者/リンギスト。訳書に「血と汗とピクセル」、著書に「アプリケーションをつくる英語」(第4回ブクログ大賞)、「ITエンジニアのための英語リーディング」、「ソフトウェア・グローバリゼーション入門」、「アプリ翻訳実践入門」など。ブログTwitter

頻出英語表現(1):詳細は◯◯を参照してください

プログラミング関連のドキュメントで頻出する英語表現を紹介します。とりわけAPIリファレンスやマニュアルでよく用いられる表現を取り上げます。


今回は「詳細は◯◯を参照してください」という表現です。その文章内では説明しきれないような場合に、別のページや外部サイトへのアクセスを促すのに使います。

▼ For more information, see …

これが最も基本的な形です。「…」の部分にリンク先やURLなどが入ります。例:

  • For more information, see our website.
    • 詳細は弊社ウェブサイトを参照してください。
  • For more information, see the following documents:
    • 詳細は以下のドキュメントを参照してください:

information about/on

何についての情報かという点を詳しく説明したい場合、前置詞にaboutやonを使います。例:

  • For more information about these commands, see Commands.
    • これらのコマンドに関する詳細は「コマンド」を参照してください。
  • For more information on this file, see our documentation.
    • このファイルに関する詳細は、当社ドキュメントを参照してください。

information about how to / 動詞ing

マニュアルであれば何かをする方法の説明を書くこともよくあります。「〜する方法についての情報」には「information about how to 〜」や「information about 動詞ing」が使われます。例:

  • For more information about how to create an account, see How to create an account.
    • アカウントを作成する方法の詳細は「アカウントの作成方法」を参照してください。
  • For more information about installing the app, see Installing an app.
    • アプリをインストールする方法の詳細は「アプリをインストールする」を参照してください。

see以外の動詞

「参照してください」の部分にはseeが最もよく用いられますが、同じ動詞ばかりだと単調です。その場合、go toreadrefer tovisitといった動詞も使われます。例:

  • For more information, go to the next section.
    • 詳細は、次のセクションに移動してください。
  • For more information, read this page.
    • 詳細は、このページをお読みください。
  • For more information, refer to Uploading a file.
    • 詳細は「ファイルをアップロードする」を参照してください。
  • For more information, visit our website.
    • 詳細は、弊社のウェブサイトにアクセスしてください。

For details / For information

文頭の「more information」は、文字通りには「さらなる情報」であるため、日本語では「詳細」という言葉がよく当てられます。ここを変更することもできます。

まずdetails(複数形である点に注意)を使った「For details」や「For more details」です。例:

  • For details, visit www.example.com.
    • 詳細は、www.example.comにアクセスしてください。
  • For more details, see this section.
    • 詳細は、このセクションを参照してください。

なお「for details」は文末に置かれることもあります。例:

  • To install the app, see our website for details.
    • アプリをインストールするには、弊社ウェブサイトで詳細を参照してください。

次にmoreを除いた「For information」という形です。moreではないので、それまでに登場していない別の情報を紹介する際に使えます。例:

  • For information about how to upgrade your account, see this page.
    • アカウントのアップグレード方法についての情報は、こちらのページをご覧ください。

▼ To learn more, see …

よく使われるのが上記の「For more information, see …」という基本形です。この冒頭部分を変更することで、表現に変化をつけられます。代表的なのが「To learn more, see …」です。文字通りには「もっと知るには〜を参照してください」という意味ですが、やはり「詳細は〜を参照してください」という日本語がよく当てられます。例:

  • To learn more, see Removing a user.
    • 詳細は「ユーザーを削除する」を参照してください。

この「To learn」でも、前述のように「about how to」などを付けたり、動詞をsee以外にしたり、moreを削除したりといった応用ができます。例:

  • To learn about how to use this device, visit our website.
    • このデバイスを使う方法については、当社ウェブサイトをご覧ください。

[筆者について]
西野竜太郎。IT分野の英語翻訳者/リンギスト。訳書に「血と汗とピクセル」、著書に「アプリケーションをつくる英語」(第4回ブクログ大賞)、「ITエンジニアのための英語リーディング」、「ソフトウェア・グローバリゼーション入門」、「アプリ翻訳実践入門」など。ブログTwitter

英文スタイルガイド解説(11):UI要素の書き方2 ― ウィンドウなど

本記事は「プログラミング英語検定ニュースレター #11」(2020年9月29日発行)からの一部抜粋です。同ニュースレターでは、検定のクーポン情報や英語解説などを定期的に発信しています。登録はこちらから。

Googleが公開している開発者向け英文スタイルガイドから項目を1つ取り上げて紹介します。スタイルガイドは基本的には書く際に利用されますが、読む際にも参考になります。

ウィンドウ、メニュー・バーなど

URL:https://developers.google.com/style/ui-elements#ui-terms (2020-09-28閲覧)

開発者であれば、ちょっとした操作説明を英語で書く機会があります。今回は、操作説明におけるUI要素の書き方の2回目です(第1回はこちら)。なお英語例文はGoogleのものです。

ウィンドウなどの画面区画

画面の区画を指す英単語がいくつかあります。以下のように使い分けます。

window:あるアプリ全体のウィンドウに加え、そのアプリの一部になっているツールなどのウィンドウを指すのにも使う

page:主にウェブ・ページを指すのに使う

dialog:メインのアプリケーション・ウィンドウの手前に表示され、独立した小さなウィンドウを指すのに使う

  • ✕:In the Welcome pop-up window, click OK.
  • ◯:In the Welcome dialog, click OK.

pane:ウィンドウの中にある区画を指すのに使う。発音は「ペイン」で、一般英語としては「窓のガラス1枚」を指す(「田」の形の窓なら4枚のペインがある)。

前置詞は基本的に「in」ですが、pageの場合だけは「on」を使います。

  • ◯:In the Task window, click Start.
  • ◯:On the Create an instance page, click Add.

また「In 〜」のように、操作の場所を先に書くようにしましょう。そうすると、読者の視線の移動に合います。

メニュー・バー

ウィンドウや画面の最上部にあるのがメニュー・バー(menu bar)です。

メニュー・バーでは「ファイル」→「保存」のように、下位項目を連続して選択する操作がよくあります。この連続操作では「>」を使って示します。

  • ◯:Select View > Tools > Developer Tools.

Googleのスタイルガイドでは、この「>」を使った表記方法はメニュー・バーのみに使うとしています。また「>」自体もUIと同じくボールドとしています。

ボタンとアイコン

ボタンを指し示す際は、ボタンのラベルを使います。

  • ✕:Click the “OK” button.
  • ◯:Click OK.

ボタンがアイコンの場合、ツールチップに表示される名前(マウス・カーソルを置いたときにポップアップで出る名前)を書き、その直後にアイコン画像を表示します。

  • ✕:Click the + icon.
  • ◯:Click Add +. (※「+」は画像)

また、UI要素に三点リーダー(エリプシス)がある場合は含めません。

  • ✕:Click Browse ….
  • ◯:Click Browse.

(ライセンス表示: Portions of this page are modifications based on work created and shared by Google and used according to terms described in the Creative Commons 4.0 Attribution License.)


[筆者について]
西野竜太郎。IT分野の英語翻訳者/リンギスト。訳書に「血と汗とピクセル」、著書に「アプリケーションをつくる英語」(第4回ブクログ大賞)、「ITエンジニアのための英語リーディング」、「ソフトウェア・グローバリゼーション入門」、「アプリ翻訳実践入門」など。ブログTwitter

英文スタイルガイド解説(10):UI要素の書き方1 ― ボールドなど

本記事は「プログラミング英語検定ニュースレター #10」(2020年8月28日発行)からの一部抜粋です。同ニュースレターでは、検定のクーポン情報や英語解説などを定期的に発信しています。登録はこちらから。

Googleが公開している開発者向け英文スタイルガイドから項目を1つ取り上げて紹介します。スタイルガイドは基本的には書く際に利用されますが、読む際にも参考になります。

ボールドで囲む、theを付けるか

URL:https://developers.google.com/style/ui-elements#formatting (2020-08-26閲覧)

開発者であれば、ちょっとした操作説明を英語で書く機会はあります。そのときボタン名やメニュー名などのUI要素をどう扱うか悩むはずです。今回から複数回にわたって、操作説明におけるUI要素の書き方を解説します。なお英語例文はGoogleのものです。

ボールドで囲む

日本語ではUI要素を鍵かっこで囲ったり(例:「編集」を選択)、角かっこで囲ったり(例:[履歴] をクリック)することが多いかと思います。英語で書くときは、UI要素をボールドで書くようにします。

  • ✕: In the New Project window, select “New Activity”, and then click the “Next” button.
    • → ダブルクォーテーション(” “)は使わない
  • ◯: In the New Project window, select the New Activity checkbox, and then click Next.

theを付けるか付けないか

上記の例では「In the New Project window」と定冠詞theが付いていたり、「click Next」と付いていなかったりします。冠詞がない日本語の母語話者にとっては対応に悩む部分です。

例文をよく見ると、theがあるのは「the New Project window」のwindowや「the New Activity checkbox」のcheckboxのような普通名詞がUI要素の後に置かれるときです。他方、UI要素そのままの場合(例:click Next)にはtheがありません。これは文法的に言うと、普通名詞ではなく「固有名詞」のように扱われているためだと思われます。

つまりルールとしては、
・UI要素の後ろにwindowなど普通名詞が付く → theは必要
・UI要素がそのまま → theは不要
となります。

実際、別の例文を見ても上記の形となっています。

  • ◯: In the File menu, click Tools.
  • ◯: In the MyApp window, click Edit.

(ライセンス表示: Portions of this page are modifications based on work created and shared by Google and used according to terms described in the Creative Commons 4.0 Attribution License.)


[筆者について]
西野竜太郎。IT分野の英語翻訳者/リンギスト。訳書に「血と汗とピクセル」、著書に「アプリケーションをつくる英語」(第4回ブクログ大賞)、「ITエンジニアのための英語リーディング」、「ソフトウェア・グローバリゼーション入門」、「アプリ翻訳実践入門」など。ブログTwitter

英文スタイルガイド解説(9):メソッド説明の書き方2

本記事は「プログラミング英語検定ニュースレター #9」(2020年7月31日発行)からの一部抜粋です。同ニュースレターでは、検定の最新情報や英語解説を定期的に発信しています。登録はこちらから。

Googleが公開している開発者向け英文スタイルガイドから項目を1つ取り上げて紹介します。スタイルガイドは基本的には書く際に利用されますが、読む際にも参考になります。

APIリファレンスのメソッドの書き方 ― 2

URL:https://developers.google.com/style/api-reference-comments#parameters (2020-07-30閲覧)

APIリファレンスの書き方に関するページから紹介します。前回はメソッド説明の書き方を取り上げました。今回はメソッドのパラメーターや戻り値などの書き方です。なお英語例文はGoogleのものです。

パラメーター

パラメーターの説明を書く際は、以下のガイドラインに従います。

  • 大文字で書き始め、末尾にはピリオドを付ける
  • ブール値でなければ、定冠詞(the)や不定冠詞(a)で書き始める
    • 上記例:
      • The ID of the bird you want to get.
      • A description of the bird.
  • ブール値であれば、「If true/false, <命令文>」や「True if 〜; false otherwise.」といった構文にする
    • 例:
      • If true, turn traffic lines on. If false, turn them off.
      • True if the zoom is set; false otherwise.

簡潔な記述を目的としているため、主語と動詞がある「きちんとした」英文ではありません。そのため、慣れてなければ違和感を覚えるかもしれません。

また「True if 〜; false otherwise.」は「〜ならtrue、そうでなければfalse」という意味で、APIリファレンスに特有の表現です。otherwiseはプログラミング必須英単語600+のアドバンスト300に入っていますが、この構文での使い方が目立ちます。

戻り値

  • ブール値以外であれば、「The …」で書き始める
    • 例:
      • The bird specified by the given ID.
  • ブール値であれば、「True if …; false otherwise.」という構文にする
    • 例:
      • True if the bird is in the sanctuary; false otherwise.

ブール値以外は「The …」(定冠詞)とされていますが、実際には不定冠詞(a)で示すのが適当な戻り値もあります。

例外

  • 見出しにすでに「Throws」という言葉があれば「If …」で書き始める
    • 例:
      • If no key is assigned.
  • なければ「Thrown when …」で書き始める
    • 例:
      • Thrown when no key is assigned.

なおthrownはthrow(スローする。ベーシック300)の過去分詞形で、「スローされる」という意味です。

非推奨

メソッドなどが非推奨となった場合、文の最初にその旨を書きます。後続の文に理由や代替手段を書きます。

  • 例:
    • Deprecated. Use #CameraPose instead.
    • Deprecated. Access this field using the getField() method.

deprecatedは「非推奨の」という意味の形容詞で、アドバンスト300に入っています。

(ライセンス表示: Portions of this page are modifications based on work created and shared by Google and used according to terms described in the Creative Commons 4.0 Attribution License.)


[筆者について]
西野竜太郎。IT分野の英語翻訳者/リンギスト。訳書に「血と汗とピクセル」、著書に「アプリケーションをつくる英語」(第4回ブクログ大賞)、「ITエンジニアのための英語リーディング」、「ソフトウェア・グローバリゼーション入門」、「アプリ翻訳実践入門」など。ブログTwitter

英文スタイルガイド解説(8):メソッド説明の書き方1

本記事は「プログラミング英語検定ニュースレター #8」(2020年6月29日発行)からの一部抜粋です。同ニュースレターでは、検定の最新情報や英語解説を定期的に発信しています。登録はこちらから。

Googleが公開している開発者向け英文スタイルガイドから項目を1つ取り上げて紹介します。スタイルガイドは基本的には書く際に利用されますが、読む際にも参考になります。

APIリファレンスのメソッドの書き方(1)

URL:https://developers.google.com/style/api-reference-comments#methods (2020-06-28閲覧)

APIリファレンスの書き方に関するページから紹介します。今回はメソッド説明の書き方です。

メソッド説明の最初の1文には、その動作内容を簡潔に書きます。後続の文で以下の内容を説明します。

  • なぜ使うか
  • どう使うか
  • 呼び出す際の要件
  • 発生しうる例外の詳細
  • 関連するAPI

同スタイルガイドでは、Androidの「isChangingConfigurations()」メソッドの説明として、以下の例文を挙げています。

Checks whether this activity is in the process of being destroyed in order to be recreated with a new configuration. This is often used in onStop() to determine whether the state needs to be cleaned up or will be passed on to the next instance of the activity via onRetainNonConfigurationInstance().

まず1文目で「Checks whether …」(〜かどうかを確認)と動作内容を記述しています。続く2文目で「This is often used in …」と、メソッドを使う目的や状況を説明しています。

上記例文にあるように、メソッドでは文頭に動詞を使って処理を説明します。その際、次の動詞を用いるとしています。

  • ブール値を返す場合: “Checks whether …”
  • ブール値以外を返す場合: “Gets the …”
  • 戻り値がない場合:
    • 機能や設定をオンに: “Sets the …”
    • プロパティーを更新: “Updates the …”
    • 何かを削除: “Deletes the …”
    • コールバックなどを登録: “Registers …”
    • コールバック(典型的にはonで始まるメソッド): “Called by …”
  • クラス・オブジェクトを生成: “Creates a …”

こういったメソッド説明の冒頭などで用いる動詞は「プログラミング英語教本」(2-2-2)でも紹介しており、上記以外では次の動詞もよく使われます。

  • add(追加する)
  • construct(コンストラクターで生成する)
  • determine(判別する)
  • indicate(示す)
  • remove(削除する)
  • retrieve(取得する)
  • return(戻す)

(ライセンス表示: Portions of this page are modifications based on work created and shared by Google and used according to terms described in the Creative Commons 4.0 Attribution License.)


[筆者について]
西野竜太郎。IT分野の英語翻訳者/リンギスト。訳書に「血と汗とピクセル」、著書に「アプリケーションをつくる英語」(第4回ブクログ大賞)、「ITエンジニアのための英語リーディング」、「ソフトウェア・グローバリゼーション入門」、「アプリ翻訳実践入門」など。ブログTwitter

英文スタイルガイド解説(7):数の書き方2

本記事は「プログラミング英語検定ニュースレター #7」(2020年5月27日発行)からの一部抜粋です。同ニュースレターでは、検定の最新情報や英語解説を定期的に発信しています。登録はこちらから。

Googleが公開している開発者向け英文スタイルガイドから項目を1つ取り上げて紹介します。スタイルガイドは基本的には書く際に利用されますが、読む際にも参考になります。

数の書き方(2)

URL:https://developers.google.com/style/numbers (2020-05-26閲覧)

前回取り上げた「数の書き方(1)」の続きです。

パーセンテージ

数字と記号(%)を使い、間にスペースは入れない(例:40%)。ただし文頭に置く場合、どちらもスペルアウトして(つづりで)書く。

 ◯ Forty percent of the files

数の範囲

ハイフンを使い、間にスペースは入れない。

 ◯ 2012-2016

日本語では範囲を示すのに「〜」(波ダッシュ)を使いますが、英語では使いません。特に形が似ているチルダ(~)は、英語では数字の前に付けると「約」や「およそ」の意味(例:「~40」で「約40」)となり、誤解の原因になりうるので注意しましょう。

桁区切りと小数点

アメリカの標準を使う。つまり3桁ごとの区切りにカンマ(,)、小数点にピリオド(.)。

 ◯ The limit is 1,532,784 bytes per day.
 ◯ $0.031611/vCPU hour

これは日本でも同じなので、なぜわざわざ説明するのか疑問に思われるかもしれません。実は、桁区切りにピリオド(または空白)を使う国や、小数点にカンマを使う国があります。例えば以下の通りです。

  • 日/米:1,234,567.89
  • ドイツ:1.234.567,89
  • フランス:1 234 567,89

寸法

小文字のxを使い、間にスペースは入れない。

 ◯ 192×192

(ライセンス表示: Portions of this page are modifications based on work created and shared by Google and used according to terms described in the Creative Commons 4.0 Attribution License.)


[筆者について]
西野竜太郎。IT分野の英語翻訳者/リンギスト。訳書に「血と汗とピクセル」、著書に「アプリケーションをつくる英語」(第4回ブクログ大賞)、「ITエンジニアのための英語リーディング」、「ソフトウェア・グローバリゼーション入門」、「アプリ翻訳実践入門」など。ブログTwitter

英文スタイルガイド解説(6):数の書き方1

本記事は「プログラミング英語検定ニュースレター #6」(2020年4月30日発行)からの一部抜粋です。同ニュースレターでは、検定の最新情報や英語解説を定期的に発信しています。登録はこちらから。


Googleが公開している開発者向け英文スタイルガイドから項目を1つ取り上げて紹介します。スタイルガイドは基本的には書く際に利用されますが、読む際にも参考になります。

数の書き方(1)

URL:https://developers.google.com/style/numbers (アクセス:2020-04-29)

日本語でも、たとえば「二進法」なのか「2進法」なのか、数の書き方で悩むことがあります。今回は英語で書く際、スペルアウトするケースと、数字を使うケースとについて取り上げます。なお「◯」はGoogleが挙げる良い例です。

スペルアウトするケース

一般的に、次のケースではスペルアウトします(つづりで書く)。

  • 0〜9の数
    • 例:zero、one、five、nine
    • ◯ four options、five minutes、nine developers
    • ただし後述の「数字を使うケース」に挙げる例外は除く(例:バージョン番号の「version 3」)
  • 文の先頭の数
    • ◯ Fifteen directories are created.
      • → 「15」ではなく「fifteen」
      • 数字を文の先頭に置かないよう、構文を変える工夫が必要なことも
  • 数字が後に続く数
    • ◯ This procedure creates fifteen 100,000-byte files.
    • → 「15」ではなく「fifteen」
  • 大まかな数
    • ◯ You can specify thousands of combinations.
    • → 「1000」ではなく「thousand」

数字を使うケース

一般的に、次のケースでは数字を使います。

  • 10以上の数
    • 例:10、11、256
    • ※ ただし以下は10未満でも常に数字を使う。
      • バージョン番号(◯ version 3)
      • 技術関連の数値(例:メモリー容量、クエリー数)
      • ページ番号
      • 章や節などの番号
      • 価格
      • 単位が付かない数(例:数式中の数)
  • 10以上の数が登場する文で使われる、10未満の数
    • ◯  The menu contains 15 options but 6 of them are disabled.
      • → 「15」があるので「six」ではなく「6」。つまりスペルアウトを混ぜない
  • 負数
  • 分数(ほとんどの場合)
  • パーセンテージ
  • 寸法
    • ◯ 192×192
  • 小数
    • ◯ 0.3 inch
  • 範囲
    • ◯ 2012-2016

かなり細かいルールもありますが、少なくとも「0〜9はスペルアウトすることがある」という点は覚えておきたいところです。

(ライセンス表示: Portions of this page are modifications based on work created and shared by Google and used according to terms described in the Creative Commons 4.0 Attribution License.)


[筆者について]
西野竜太郎。IT分野の英語翻訳者/リンギスト。訳書に「血と汗とピクセル」、著書に「アプリケーションをつくる英語」(第4回ブクログ大賞)、「ITエンジニアのための英語リーディング」、「ソフトウェア・グローバリゼーション入門」、「アプリ翻訳実践入門」など。ブログTwitter

英文スタイルガイド解説(5):リストの使い方2

本記事は「プログラミング英語検定ニュースレター #5」(2020年3月20日発行)からの一部抜粋です。同ニュースレターでは、検定の最新情報や英語解説を定期的に発信しています。登録はこちらから。


Googleが公開している開発者向け英文スタイルガイドから項目を1つ取り上げて紹介します。スタイルガイドは基本的には書く際に利用されますが、読む際にも参考になります。

リストの使い方(2)

URL:https://developers.google.com/style/lists (アクセス:2020-03-19)

今回は、情報を見やすく整理するリストの使い方に関する第2回目です(1回目はウェブ上にも掲載)。

導入文

項目を列挙するリストの前には「導入文」を置きます。直後に項目を列挙する場合、導入文の末尾はコロン(:)とします。

良い例1:

Use the Submit button for any of the following purposes:
– To submit the form.
– To indicate that you’re done.
– To allow the next person to enter their data.

良い例2:

To get the USB driver, follow these steps:
1. Click Tools > Android > SDK Manager.
2. Select Google USB Driver, and then click OK.

良い例1を見ると「… the following purposes:」とあります。「following」は形容詞で「以下の〜」、名詞で「以下のもの」という意味があります。非常に便利に使える単語なので、ぜひ覚えておいてください。

また導入文は、それ自体で完全な文の形とし、各項目の末尾まで読んだら完全な文となるようには書きません(以下の悪い例)。

悪い例:

Use the Submit button to:
– Submit the form.
– Indicate that you’re done.
– Allow the next person to enter their data.

→ 1つめの項目の場合、「Use the Submit button to submit the form.」と末尾まで読んで初めて完全な文となる。そのため良くないとされる

項目内のピリオド

リストの各項目は大文字で書き始めます。また末尾にピリオドを付けるかどうかは、日本語でも悩ましいですが、Google開発者スタイルガイドでは大まかな指針を以下としています。

  • 項目が1つの単語で構成される場合、ピリオドは付けない
  • 項目に動詞が含まれない場合、ピリオドは付けない
  • 項目全体にソースコード用フォントが使われる場合、ピリオドは付けない

Googleによる例を見てみます。

良い例1:

The following words are adjectives:
– Big
– Small
– Gratuitous

良い例2:

You can do any of the following by using the API:
– Create an item.
– Replace one item with another.
– Update an item.
– Delete an item.

→ 動詞なのでピリオドあり。またここのfollowingは名詞で、常に単数形で使う(followingsとしない)

(ライセンス表示: Portions of this page are modifications based on work created and shared by Google and used according to terms described in the Creative Commons 4.0 Attribution License.)


[筆者について]
西野竜太郎。IT分野の英語翻訳者/リンギスト。訳書に「血と汗とピクセル」、著書に「アプリケーションをつくる英語」(第4回ブクログ大賞)、「ITエンジニアのための英語リーディング」、「ソフトウェア・グローバリゼーション入門」、「アプリ翻訳実践入門」など。ブログTwitter

英文スタイルガイド解説(4):リストの使い方1

本記事は「プログラミング英語検定ニュースレター #4」(2020年2月19日発行)からの一部抜粋です。同ニュースレターでは、検定の最新情報や英語解説を定期的に発信しています。登録はこちらから。


Googleが公開している開発者向け英文スタイルガイドから項目を1つ取り上げて紹介します。スタイルガイドは基本的には書く際に利用されますが、読む際にも参考になります。

今回は、情報を見やすく整理するリストの使い方に関する第1回目です。

リストの使い方(1)

URL:https://developers.google.com/style/lists (アクセス:2020-02-18)

同スタイルガイドでは、リストの種類として以下の5つを挙げています。

番号リスト

順に実行する手順で使う。

例:

Here’s a sequence of steps to follow:
  1. Open the box.
  2. Remove the bobcat from the box.
  3. Feed the bobcat.

使うHTML要素:ol、li

文字リスト(アルファベット大文字)

選択肢(とりわけ択一)を示すのに使う。

例:

A. Java
B. JavaScript
C. Go
D. Dart

使うHTML要素:ol(”upper-alpha”)、li

中黒リスト

順序でも選択肢でもないもので使う。

例:

Here’s a list of things that can go wrong, in no particular order:
  ・Your bicycle might explode.
  ・The sun might go out.
  ・An ant might break its leg and require a tiny splint.

使うHTML要素:ul、li

説明リスト

用語と、その定義や解説というセットに使う(用語集)。

例:

Here are some descriptions of types of birds:
Emu
    The best kind of bird.
Crow
    The other best kind of bird.
Peacock
    Also the best kind of bird.
Phoenix
    An even better kind of bird.

使うHTML要素:dl、dt、dd

見出し中黒の説明リスト

スペースを節約しつつ、用語+定義などのセットに使う。見出しはボールド。

例:

Here are some descriptions of types of birds:
  ・Emu. The best kind of bird.
  ・Crow. The other best kind of bird.
  ・Peacock. Also the best kind of bird.
  ・Phoenix. An even better kind of bird.

使うHTML要素:ul、li


なお、項目を見やすく提示する方法としては「リスト」のほかに「テーブル」があります。どちらを使うかの判断基準として以下が挙げられています(リンク。2020-02-18アクセス)。

・各項目が1つのまとまり。例:プログラミング言語名一覧、手順
  → 番号リスト、文字リスト、中黒リスト(ol、ul)
・各項目がペアのデータ。例:用語と定義
  → 説明リスト(dl)
・各項目が3つ以上のデータ
  → テーブル

(ライセンス表示: Portions of this page are modifications based on work created and shared by Google and used according to terms described in the Creative Commons 4.0 Attribution License.)


[筆者について]
西野竜太郎。IT分野の英語翻訳者/リンギスト。訳書に「血と汗とピクセル」、著書に「アプリケーションをつくる英語」(第4回ブクログ大賞)、「ITエンジニアのための英語リーディング」、「ソフトウェア・グローバリゼーション入門」、「アプリ翻訳実践入門」など。ブログTwitter