英文スタイルガイド解説(3):手順の書き方

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


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

今回は手順の書き方について、重要と思われるポイントをいくつか紹介します。

手順の書き方(Procedures)

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

導入文

通常、手順の前に導入文を書きます。単に見出しを繰り返すのではなく、読者に状況を説明します。

導入文の直後に手順が来る場合、コロン(:)を使います。一方、導入文と手順と間に注などが入る場合、普通の文と同様にピリオド(.)で終えます。

導入文はそれ自体で完全な文の形にして書きます。

✕ To customize the buttons:
◯ To customize the buttons, follow these steps:

(◯は命令文として完全な文になっている)

ステップが1つの手順

ステップが1つだけの手順の場合、導入文の中に組み込みます。

✕ To clear (flush) the entire log, follow this step:
   1. Click Clear logcat.
◯ To clear (flush) the entire log, click Clear logcat.

操作が複数ある手順

一般的には、1つの操作に対してステップ1つとします。ただし細かな操作はまとめることが可能で、メニューの連続選択では「>」を使います。

◯ 1. Click File > New > Document.

その他のポイント

【A】まず目的を書いてから操作を書く(「節の順序」も参照)

✕ 1. Click File > New > Document to start a new document.
◯ 1. To start a new document, click File > New > Document.

例では「新規ドキュメントを始めるには」という目的が最初に置かれています。

【B】まず場所を書いてから操作を書く

✕ 1. Click File > New > Document in Google Docs.
◯ 1. In Google Docs, click File > New > Document.

例では「Google Docs」という場所が最初に置かれています。

【C】Pleaseは使わない

✕ 1. To open a document, please click File > Open.
◯ 1. To open a document, click File > Open.

英語の指示文では、pleaseなしの命令形が一般的です。

【D】省略可能な任意のステップでは最初に「Optional:」を付ける

◯ 1. Optional: Type an arbitrary string, to be delivered to the target address with each notification delivered over this channel.

【E】方向を示す言葉(例:above、below、right-hand side)で場所を指示しない。アクセシビリティーやローカリゼーション(翻訳)で問題が発生しうるため

たとえばアラビア語など文字を右から左に書く言語の場合、UI要素の配置位置も左右逆になります。そういった言語に翻訳されると、指示の場所が逆になります。

またパソコンとスマホで画面レイアウトが変わるようなレスポンシブなデザインでUIを作成した場合も同様の問題が発生する可能性がありそうです。

(ライセンス表示: 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