Googleが公開している開発者向け英文スタイルガイドから項目を1つ取り上げて紹介します。スタイルガイドは基本的には書く際に利用されますが、読む際にも参考になります。
記事の英語難易度は「中〜上級」です。
英語でマニュアルなどを書く際、URLを例示したり、サンプルのユーザー名を提示したりすることがあります。今回はそういったサンプルや例示で使う名前です。
URL： https://developers.google.com/style/examples （2022-05-07閲覧）
ドメイン名
ジェネリックのドメイン名としては下記が使えます。
- example.com
- example.org
- example.net
どれも例示用に予約されているドメインです（参考：RFC 2606）。なお国別のjpドメインの場合は「example.jp」「example.co.jp」「example.ne.jp」も使えます（参考：JPRS）。
メールアドレス
上記のドメイン名を使うと、サンプルのメールアドレスも作れます。例えば次のようなアドレスです。
- sara@example.com
- taro@example.org
- hanako@example.co.jp
人名
Googleのスタイルガイドでは、サンプルの人名として次のリストを挙げています。ユーザー名などを例示する際に使えます。
- Alex
- Amal
- Ariel
- Bola
- Charlie
- Cruz
- Dana
- Dani
- Hao
- Ira
- Izumi
- Jie
- Kai
- Kalani
- Kim
- Kiran
- Lee
- Lucian
- Luka
- Mahan
- Noam
- Nur
- Quinn
- Raha
- Rosario
- Sasha
- Tal
- Taylor
- Tristan
- Yuri
単数のthey/their/themを使う
ここ10年くらいの間に「単数のthey」（参考：Wikipedia）を使うとするスタイルガイドが増えています。Googleスタイルガイドも、可能であれば単数のtheyを使うとしています。
例えば、従来は「Every user can change his password.」（あるいは「his or her」）のように書かれていました。userは性別が不明ですが、男性のhisで受けています。単数のtheyとは、こういった場面で性別を明示しないthey/their/themを使う書き方です。つまり「Every user can change their password.」となります。they/their/themは複数の代名詞なので「Every user」とは数が一致しません。これまでくだけた表現とされていましたが、最近のスタイルガイドでは推奨するようになっています。
ステレオタイプを助長するサンプルは使わない
Googleスタイルガイドでは、性別や人種などのステレオタイプを助長するサンプルには注意するとしています。
例えば、エンジニアには男性が多そうだという理由で男性名ばかりを使うようなケースが考えられそうです。
会社名
会社名のサンプルは「Example Organization」にするとしています。
2つ以上必要になる場合は、何かしらの説明を加えた社名にします。例として「Enterprise Example Organization」や「Startup Example Organization」が挙げられています。
電話番号
アメリカの電話番号の場合、「(800) 555-0100」〜「(800) 555-0199」を使うとしています。
この間の番号は例示やフィクション向けに予約されているようです。
IPアドレス
IPv4
IPv4のサンプルは、以下の範囲のものを使います（参考：RFC 5737）。
- 192.0.2.0/24
- 198.51.100.0/24
- 203.0.113.0/24
「/24」の部分はサブネットマスクを表しているので、具体的なIPアドレスとしてGoogleスタイルガイドは以下を例に挙げています。
- 192.0.2.1
- 198.51.100.1
- 203.0.113.1
なお一番上の範囲の場合、「192.0.2.1」〜「192.0.2.254」までがホストのIPアドレスなので、どれを使っても問題ないでしょう。
IPv6
IPv6のサンプルは、以下の範囲のものを使います（参考：RFC 3849）。
- 2001:DB8::/32
具体的なアドレスとしてGoogleスタイルガイドは以下を挙げています。
- 2001:db8::
- 2001:db8:ffff:ffff:ffff:ffff:ffff:ffff
- 2001:db8:1:1:1:1:1:1
- 2001:db8:2:2:2:2:2:2
- 2001:db8:3:3:3:3:3:3
- 2001:db8:4:4:4:4:4:4
住所
サンプルの住所として、以下のいずれかを使うとしています。
- 1800 Amphibious Blvd.
Mountain View, CA 94045 - Avenida da Pastelaria, 1903
Lisbon, 1229-076 - 8 Rue du Nom Fictif
341 Paris
プロジェクト名
プロジェクト名を付ける場合、foo、barなど意味がない名前は使わず、ユーザーにとって意味がありそうな名前にします。また必要な場合は数字を末尾に加えます。
Googleスタイルガイドは次の例を挙げています。
- Development
- Staging
- Android Development-1
- Production-1
- Production-2
プレースホルダーの利用
上記のような架空の名前ではなく、「USER_ID」や「EMAIL_ADDRESS」のようなプレースホルダーも使えるとしています。
プレースホルダーとは、後でそこに具体的な値を入れるために、仮に置いておく文字や記号です。なおプレースホルダーの形式は「大文字で書き、アンダースコアで区切る」にするとしています（参考）。
（ライセンス表示： 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.）
[筆者紹介]
