Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Word usage updates: screenshot, lookup, see/refer to #546

Merged
merged 4 commits into from
Nov 23, 2023
Merged

Word usage updates: screenshot, lookup, see/refer to #546

merged 4 commits into from
Nov 23, 2023

Conversation

julian-cable
Copy link
Collaborator

No description provided.

This was linked to issues Nov 22, 2023
Revise guidance to use "refer to" and not "see" for references #533
Closed
Update advice for "look-up" #535
Closed
Review existing ban on "screenshot"? #540
Closed
rclee33
rclee33 reviewed Nov 22, 2023
View reviewed changes
Copy link
Contributor

@rclee33 rclee33 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added some notes.

en-US/R.xml Outdated
@@ -118,7 +118,8 @@
<term>refer to</term>
<listitem>
<para>
Do not use to indicate a reference (within a manual) or a cross-reference (to another manual or documentation source). Use "See".
Use to refer readers to another resource.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For clarity, I suggest not using the term itself in the description. Suggest: Use to provide readers with a resource.

en-US/R.xml Outdated
@@ -118,7 +118,8 @@
<term>refer to</term>
<listitem>
<para>
Do not use to indicate a reference (within a manual) or a cross-reference (to another manual or documentation source). Use "See".
Use to refer readers to another resource.
<!-- Do not use to indicate a reference (within a manual) or a cross-reference (to another manual or documentation source). Use "Refer to". -->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this line missing the word "see"? "Do not use "see" to indicate...

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Won't fix: this line is the previous entry, now commented out.

en-US/S.xml Outdated
@@ -112,7 +112,7 @@
</table>
</listitem>
</varlistentry>
<varlistentry id="see">
<!-- <varlistentry id="see">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the "see" entry being removed from the word usage guide? I suggest keeping it, saying something like "not preferred" or "do not use", and providing some guidance about using more accessible language, possibly with examples. "See" comes up in a few contexts for content -- not only for references, but also when describing screenshots or output.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's a suggested entry for "see". I'm unsure about the examples -- input welcome!

For references within a document, and for cross-references to other resources, do not use “see”. Use “refer to”.

For descriptions of graphics, explanations of command outputs, and other similar cases, it is acceptable to use “see”. At the same time, it might be more concise or precise to replace “see” with another verb in these cases.

Examples:
Original: Click a server link to see the result details:
Update: Click a server link for the result details:
Update: For the result details, click a server link:

Original: As you can see, these are expected Audit events with an AVC Audit record.
Update: As shown in the output, these are expected Audit events with an AVC Audit record.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good suggestion - thanks!

rclee33
rclee33 reviewed Nov 22, 2023
View reviewed changes
Copy link
Contributor

@rclee33 rclee33 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one fix!

en-US/S.xml Outdated
<para>
For descriptions of graphics, explanations of command outputs, and other similar cases, it is acceptable to use “see”.
Alternatively, it might be more concise or precise to replace “see” with another verb in these cases.
For example, instead of using "Click a server link to see the result details", you could use "Click a server link for the result details.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For example, instead of using "Click a server link to see the result details", you could use "Click a server link for the result details.
For example, instead of using "Click a server link to see the result details", you could use "Click a server link for the result details".

sffrench
sffrench approved these changes Nov 23, 2023
View reviewed changes
Copy link
Contributor

@sffrench sffrench left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@julian-cable julian-cable mentioned this pull request Nov 23, 2023
Closed
@julian-cable julian-cable merged commit a353d5e into dev Nov 23, 2023
@julian-cable julian-cable deleted the jcable/6.2-terms branch November 23, 2023 15:22
julian-cable added a commit that referenced this pull request Feb 27, 2024
@julian-cable @daobrien
@mweetman-redhat @CBID2 @rclee33 @harpasin @alexpdp7
Merge commits from dev to master branch for 6.2 release (#565)
ae704b2 
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sffrench sffrench sffrench approved these changes

@rclee33 rclee33 rclee33 approved these changes

@daobrien daobrien Awaiting requested review from daobrien

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
3 participants
@julian-cable @sffrench @rclee33