-
Notifications
You must be signed in to change notification settings - Fork 20
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updates on referring to object names and using realistic usernames #554
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added some notes and edits. Please let me know if you have any questions, or if you want to talk more!
en-US/Design.xml
Outdated
<listitem> | ||
<para> | ||
Include a diverse set of names in your examples to reflect the diversity of the real world. | ||
For example, use male, female, and culturally diverse names that suggest various backgrounds in examples to avoid implying that only certain groups have specific skills. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can dig more into this, but my current sense is that we might want to avoid terms such as "male" and "female" here, since those relate to biological sex, and these terms could be considered trans-exclusive when used as adjectives in some contexts. To avoid this issue, I suggest more general and inclusive language here, such as "gender inclusive". I chose "gender inclusive" over "gender neutral" because in our context, our aim is for names representing a variety of genders, rather than no gender.
en-US/Design.xml
Outdated
<listitem> | ||
<para> | ||
Include a diverse set of names in your examples to reflect the diversity of the real world. | ||
For example, use male, female, and culturally diverse names that suggest various backgrounds in examples to avoid implying that only certain groups have specific skills. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For example, use male, female, and culturally diverse names that suggest various backgrounds in examples to avoid implying that only certain groups have specific skills. | |
For example, use gender inclusive and culturally diverse names that suggest various backgrounds to avoid implying that only certain groups have specific skills. |
en-US/Design.xml
Outdated
For example, use male, female, and culturally diverse names that suggest various backgrounds in examples to avoid implying that only certain groups have specific skills. | ||
When choosing names, also consider how those names might appear in email addresses, usernames, and similar contexts. | ||
An example that works well might be "John Smith", with an email address of <email>jsmith@example.com</email>. | ||
However, for the name "Brian Smith", a corresponding email address of <email>bstrong@example.com</email> might not work so well (when read out, it sounds like "be strong"). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
However, for the name "Brian Smith", a corresponding email address of <email>bstrong@example.com</email> might not work so well (when read out, it sounds like "be strong"). | |
However, for the name "Brian Strong", a corresponding email address of <email>bstrong@example.com</email> might be less effective (when read out, it sounds like "be strong"). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I kind of want to know why bstrong@
doesn't work, so that we can explain this more clearly. Is it too informal? I understand that in other cases, such abbreviations could result in inappropriate meanings -- but I'm curious about why bstrong
doesn't work. This might be something for us to clarify.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't mean "bstrong" specifically ("Be strong!") but rather be aware of how names might result in odd emails, usernames, or whatever. E.g., if you chose "Tyroner Osser" as a name the result would be not great. Long story short: be aware.
en-US/Design.xml
Outdated
@@ -899,6 +909,40 @@ STEP 14: COMMIT <emphasis>...output omitted...</emphasis> localhost/nexus:latest | |||
|
|||
</tgroup> | |||
|
|||
</table> | |||
<para> | |||
However, if the noun refers to a password, a value, or a status, then instead it flows better to state the object name first, followed by "as the password" as an example. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
However, if the noun refers to a password, a value, or a status, then instead it flows better to state the object name first, followed by "as the password" as an example. | |
However, in come cases, the sentence might be easier to understand if the noun appears first, or if additional language separates the object name from the noun. | |
For example, if the noun refers to a password, a value, or a status, then consider stating the noun first, including explanatory language between the object name and the noun, or doing both. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note that my suggested edit is to create two sentences out of one.
I think the original explanation didn't quite match the examples. For instance, the redhat
password example -- in this example, the name appears before the noun in both versions, which is the expectation (not an exception). The exception is the additional language between the name and the noun, but that wasn't described.
And the second example (the variable value) does show using the noun before the name (a value of tmp
) -- but that's not what the original explanation described.
I tried to expand the original description to include both types of examples.
I'm noticing that both of these examples are situations where values are being introduced for the first time, which is why the usual format doesn't work -- because "use the X password" or "change to the Y value" implies that this is given information (because of the definitive article). But if this is the first mention, then such phrasing can be confusing for learners, since this information is new to them. My sense is that these exceptions might make the most sense when providing the learner with new information -- but I'm not sure if that's always the case. To stay on the safe side, I didn't try to include that context in my suggested edit. (But thought I would share my thinking anyway! =)
<listitem> | ||
<para> | ||
Include a diverse set of names in your examples to reflect the diversity of the real world. | ||
For example, use male, female, and culturally diverse names that suggest various backgrounds in examples to avoid implying that only certain groups have specific skills. | ||
When choosing names, also consider how those names might appear in email addresses, usernames, and similar contexts. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Based on David's explanation, maybe we could add a line after 763 that says something like: "Avoid name combinations or abbreviations that result in unintended meanings, such as slang."
This might be kind of obvious, but seems worth explaining directly (along with the examples).
* Working on #450. * Run Vale over Design.xml. This is the end of part 1/4 of "Run Vale over the style guide." Too big a job to try to handle in one issue and PR. * Ongoing updates for #456 * Closes #456 Part 2 of running Vale over the style guide. I also addressed a few other issues along the way, such as one sentence per line and removing old comments. Language.xml in particular contains lots of examples of what not to do, so it produces lots of noise in Vale. * s/may/might/ per Julian's review. * Working on #457 Run Vale of the style guide part 3. * Closes #457 Run Vale over the style guide, part 3. * Remove spurious space. * Closes #458 Run Vale over style guide part 4. * Closes #365 Remove DocBook references. * Closes #78 Update entry for "virtualized". Basically copy/paste from corp guide. * Closes #355. Improve a bit of formatting. * feat: Add advice on naming the default branch in an inclusive way. (#493) * feat: Add advice on naming the default branch in an inclusive way. * Update en-US/Language.xml Co-authored-by: julian-cable <79939933+julian-cable@users.noreply.github.com> * Update en-US/Language.xml Co-authored-by: julian-cable <79939933+julian-cable@users.noreply.github.com> * Update en-US/Language.xml Co-authored-by: julian-cable <79939933+julian-cable@users.noreply.github.com> --------- Co-authored-by: julian-cable <79939933+julian-cable@users.noreply.github.com> * Updated section about writing titles (#492) * Updated section about writing titles * Reverted title ID * Further edits * Updated guidance on continuation prompts (#494) * Various fixes for 6.1 release (#495) * Various fixes for 6.1 release * XML fix * Updated IBM Style access info (#496) * Updated term entries (#497) * Added guidance on omitting part of an output (#500) * Added guidance on omitting part of an output * Updated wording * Typo fix * Updated sample names and other small fixes (#502) * Various fixes (#512) * Implementing various feedback suggestions from Rachel (#513) * Implementing various feedback suggestions from Rachel * Addressed review comments * Addressed further review comment * Added more punctuation guidance (#515) * Added more punctuation guidance * Implemented review feedback * Updated audience description (#518) * Updated audience description * Further updated audience wording * Adding information about posessives (#519) * feat: added section about posessives * feat: here's the actual section * fix: made some revisions * Content and formatting updates * Update en-US/Punctuation.xml Co-authored-by: Rachel Lee <131199744+rclee33@users.noreply.github.com> * fix: made some revisions * fix: made another revision * Removed company name and restructured section * added link in section 3.6 * Final XML fix --------- Co-authored-by: Julian Cable <jcable@redhat.com> Co-authored-by: Rachel Lee <131199744+rclee33@users.noreply.github.com> * Updated view and edit files section * Added release notes for 6.1 and updated version information (#522) * updating homepage (#525) * 6.2 quick fixes (#544) * Some updates concerning punctuation (#545) * Updated guidance for punctuation and special characters * Enhanced guidance about punctuation in lists * Minor formatting * Content and formatting * Applied feedback * Minor fixes * Word usage updates: screenshot, lookup, see/refer to (#546) * Word usage updates: screenshot, lookup, see/refer to * Addresses one comment * Updates to see/refer to entries * Minor fix * Line continuation for multiple operating systems (#548) * Line continuation for multiple operating systems * Minor edit * Add 64-bit architecture guidance (#547) * Add 64-bit architecture guidance * Implementing edits from review * Updated Boolean guidance and a bug fix (#551) * Updated Boolean guidance and a bug fix * Update to Boolean entry * Reworked entries for tar, tarball, untar, unzip, zip (#552) * Clarify capitalization for table titles (#553) * Updates on referring to object names and using realistic usernames (#554) * Updates on referring to object names and using realistic usernames * Apply review comments * Updates for apostrophes and quotation marks (#557) * Updates for apostrophes and quotation marks * Updated list of punctuation marks * Updated guidance about titles (#559) * Updated guidance about titles * Change 'book' to 'publication' * Footnote update (#560) * adding ulink tag to a url * Replace an invalid URL --------- Co-authored-by: Julian Cable <jcable@redhat.com> * fix(docs): add some build instructions (#562) * fix(docs): add some build instructions * feat: add build shortcut * Added small comment --------- Co-authored-by: julian-cable <jcable@redhat.com> * Corrected some titles to use title case (#563) * Add release notes and update version info (#564) * Add release notes and update version info * Minor wording fix --------- Co-authored-by: daobrien <noreply@solaris.milky.way> Co-authored-by: David O'Brien <daobrien@users.noreply.github.com> Co-authored-by: mweetman-redhat <mweetman@redhat.com> Co-authored-by: Christine Belzie <105683440+CBID2@users.noreply.github.com> Co-authored-by: Rachel Lee <131199744+rclee33@users.noreply.github.com> Co-authored-by: Harpal Singh <52556240+harpasin@users.noreply.github.com> Co-authored-by: Alex Corcoles <alex@pdp7.net>
No description provided.