StyleGuides / WritingStyleGuide

The official Red Hat guide to writing clear, concise, and consistent technical documentation.
Creative Commons Attribution Share Alike 4.0 International
71 stars 19 forks source link

Review list of example names in "Using Realistic Usernames" #536

Closed daobrien closed 5 months ago

daobrien commented 8 months ago

https://stylepedia.net/style/6.1/#use-hostnames-correctly

3.4.7.1. Using Extended User and Group Names > Using Realistic Usernames

Some of the example names used here are a bit "out there" and we could probably do better.

E.g., Jerlene Paluch, Fricis Ritcher

In a recent exchage I s/Jerlene/Jolene/ and s/Fricis/Francis/

We should also consider adding some further advice related to how chosen names might appear in example emails, usernames, and similar.

E.g., for a name like John Smith the email might be jsmith@example.com, which is fine.

If the name were Brian Strong then you get bstrong.

This doesn't seem like much of an issue, but when you introduce generated names, in different languages, the results can be unfortunate. This came up in a recent course and we had to change the name. Really all we need is a "be careful" statement so that people know what they're getting in to.