examples

✍️ google-blog-style

Source: https://developers.google.com/style/examples\n\n# Example domains and names

Stay organized with collections

Save and categorize content based on your preferences.\n\n- Home\n- Products\n- Style\n\n\n## Page Summary\n\n- Avoid using real or personally identifiable information (PII) in examples, including domain names, email addresses, and phone numbers.\n- Utilize the provided list of example data, such as reserved domain names (e.g., example.com), generic email addresses (e.g., dana@example.com), and fictional person names, for creating realistic but anonymized examples.\n- When depicting people in examples, prioritize inclusivity by using gender-neutral pronouns, diverse names, and avoiding stereotypes.\n- For company, project, street address, phone number, and IP address examples, refer to the specific guidelines and fictitious options provided to maintain user privacy.\n- Refer to the style guide for detailed instructions on placeholder usage, formatting specifics (e.g., phone numbers), and writing inclusive documentation.\n\nAvoid using real or personally identifiable information (PII) in examples, including domain names, email addresses, and phone numbers.\n\nUtilize the provided list of example data, such as reserved domain names (e.g., example.com), generic email addresses (e.g., dana@example.com), and fictional person names, for creating realistic but anonymized examples.\n\nWhen depicting people in examples, prioritize inclusivity by using gender-neutral pronouns, diverse names, and avoiding stereotypes.\n\nFor company, project, street address, phone number, and IP address examples, refer to the specific guidelines and fictitious options provided to maintain user privacy.\n\nRefer to the style guide for detailed instructions on placeholder usage, formatting specifics (e.g., phone numbers), and writing inclusive documentation.\n\nDon't use real domain names, email addresses, or people's names in your examples. Don't reveal

personally identifiable information (PII), such as domain names, email addresses,

phone numbers, people's names, project names, or credit card numbers. You can

provide imaginary (fictitious) examples or use

placeholders, like

USER_ID or EMAIL_ADDRESS.\n\n\n## Example domain names\n\nWhen you need a generic domain name in an example, use example.com,

example.org, or example.net. These domains are reserved by the

Internet Assigned Numbers Authority

for use in documentation.\n\nAlternatively, you can use any of the following domain names, which Google

owns specifically for use in documentation:\n\n- altostrat.com\n- examplepetstore.com\n- example-pet-store.com\n- myownpersonaldomain.com\n- my-own-personal-domain.com\n- cymbalgroup.com\n\nIf you need an example domain name for an internationalized domain name, use one of the

IDN Test TLDs and copy from the

"URL of the test site" column.\n\nRecommended: Hostnames that include non-ASCII characters

are encoded using Punycode. For example, http://مثال.إختبار is encoded as

xn--kgbechtv.\n\n\n## Example email addresses\n\nIf you need a generic email address, use one of the domains listed

in

Example domain names

and one of the names listed in Example person names—for

example, dana@example.com. It's OK to use generic addresses like support@example.net. Don't use

person names, product names, or made-up names in email addresses.\n\n\n## Example person names\n\nWhen you need to include example given names in your documentation,

draw from the following list:\n\n- Alex\n- Amal\n- Ariel\n- Bola\n- Charlie\n- Cruz\n- Dana\n- Dani\n- Hao\n- Ira\n- Izumi\n- Jie\n- Kai\n- Kalani\n- Kim\n- Kiran\n- Lee\n- Lucian\n- Luka\n- Mahan\n- Noam\n- Nur\n- Quinn\n- Raha\n- Rosario\n- Sasha\n- Tal\n- Taylor\n- Tristan\n- Yuri\n\n\n### Example person surnames\n\nWhen you need to include example surnames in your documentation, use an initial

after the given first name—for example, Quinn N. or Dana A.\n\n\n### Further notes about example people\n\nWhen you are writing about people, even fictitious or hypothetical people, it's important to

remember that your work will be read by real people whom we want to feel respected, valued, and

welcomed.\n\nYour audience includes different kinds of people, including people with different jobs,

cultural contexts, and backgrounds, so strive to include a variety of people in your examples

as well.\n\nUse the gender-neutral singular pronouns

they, their, and theirs

whenever possible, and avoid specifying gender unless it is integral to the information you

are communicating. Avoid examples that depend on a gender binary. However, if you do write an

example that requires specifying gender, consider that some of the names on this list may imply

a particular gender in a given language or culture, and check to ensure that any names you have

chosen do not carry a conflicting gender connotation.\n\nBe mindful of assumptions and stereotypes that might be reinforced through hypothetical

examples, such as:\n\n- Job roles and levels, such as executive, that might be disproportionately assigned

particular gendered personas.\n- Job roles, such as developer or engineer, that might be disproportionately assigned

particular ethnic personas.\n\nWe recommend using names from the preceding list in most documentation. Some security

documentation uses the

Alice and Bob

cast of characters. Don't use the Alice and Bob characters unless you're writing documentation that

refers to a technical specification that uses those characters. If you use the Alice and Bob

characters in a document, use only names from that cast of characters.\n\nFor further guidance, see the section of this guide on

writing inclusive documentation.\n\n\n## Example company names\n\nWhen you need a company name in an example, use Example Organization. If you need to

differentiate between two different fictional companies, you can add a description to the company

names. For example, you can use Enterprise Example Organization and Startup Example

Organization.\n\n\n## Example phone numbers\n\nMost phone numbers in our documentation are examples. To show an example phone number, use a US

number in the range 800‑555‑0100 through 800‑555‑0199. That range is

reserved for use in examples and in fiction.

Never use a real phone number in examples.\n\nNever use a real phone number in examples.\n\nFor information about formatting, see

Format phone numbers in HTML or Markdown.\n\n\n## Example IP addresses\n\nWhen you need an IPv4 address in an example, such as in a log, use one of the

RFC 5737 addresses that are

reserved for use in documentation:\n\n- 192.0.2.0 through 192.0.2.255\n- 198.51.100.0 through 198.51.100.255\n- 203.0.113.0 through 203.0.113.255\n\nFor IPv4 address ranges, use the following examples:\n\n- 192.0.2.0/24\n- 198.51.100.0/24\n- 203.0.113.0/24\n\nWhen you need an IPv6 address, use values from the

RFC 3849 range. Example IPv6 addresses include

the following:\n\n- 2001:db8::\n- 2001:db8:ffff:ffff:ffff:ffff:ffff:ffff\n- 2001:db8:1:1:1:1:1:1\n- 2001:db8:2:2:2:2:2:2\n- 2001:db8:3:3:3:3:3:3\n- 2001:db8:4:4:4:4:4:4\n\nFor IPv6 address ranges, use the following example:\n\n- 2001:db8::/32\n\n\n## Example street addresses\n\nAvoid using real street addresses in examples. Instead, use one of the following fictional

street addresses:\n\n- 1800 Amphibious Blvd.

Mountain View, CA 94045\n- Avenida da Pastelaria, 1903

Lisbon, 1229-076\n- 8 Rue du Nom Fictif

341 Paris\n\n\n## Example project names\n\nWhen you need an example project name, create a name that's meaningful or descriptive.\n\nEnsure that the name is applicable to the reader's environment. Don't use unclear components like

foo, bar, and baz in names.\n\nWhen necessary, use an appended numbering scheme. For example, staging,

frontend-development, backend-development, production-1,

production-2.\n\n\n## Example service account IDs\n\nWhen you need a unique ID for a service account in an example, use the numeric ID

123456789012345678901.\n\nRecommended: The allow policy shows the

identifier deleted:serviceAccount:my-service-account@my-project.iam.gserviceaccount.com?uid=123456789012345678901.\n