Skip to content

Rewrote the user guide section about the settings dialog#14937

Merged
seanbudd merged 3 commits into
nvaccess:masterfrom
XLTechie:F14927
Jun 1, 2023
Merged

Rewrote the user guide section about the settings dialog#14937
seanbudd merged 3 commits into
nvaccess:masterfrom
XLTechie:F14927

Conversation

@XLTechie

Copy link
Copy Markdown
Collaborator

Link to issue number:

Fixes #14927

Summary of the issue:

The issue asked that Ctrl+Tab and Shift+Ctrl+Tab be listed in the user guide section regarding the settings dialog, since many users don't know they can use those to move between categories.

Description of user facing changes

While editing the section, I found some awkward and seemingly redundant wording, and some unclear portions.

  • Reworded the initial paragraph to be more clear about categories and settings.
  • Added a note that Ctrl+Tab and Shift+Ctrl+Tab can move between settings categories.
  • Clarified a sentence about what shortcut keys for categories do.
  • Made the note about adding shortcut keys for categories more clear. As it was written previously, it implied that adding shortcut keys might be the ONLY way to access those categories.

Description of development approach

I tried to imagine myself in the position of a user who didn't know much about manipulating settings or their dialogs; and rewrote a bit from that prospective.

Testing strategy:

The test will be whether @Qchristensen still talks to me after reading this.

Known issues with pull request:

Change log entries:

Changes
Clarified the user guide section describing the settings dialog.

Code Review Checklist:

There is no code.

* Reworded the initial paragraph to be more clear about categories and settings.
* Clarified a sentense about what shortcut keys for categories do.
* Made the note about adding shortcut keys for categories more clear.
    - As it was written previously, it implied that adding shortcut keys might be the ONLY way to access those categories.
@XLTechie XLTechie marked this pull request as ready for review May 19, 2023 09:56
@XLTechie XLTechie requested a review from a team as a code owner May 19, 2023 09:56
@XLTechie XLTechie requested a review from Qchristensen May 19, 2023 09:56

@seanbudd seanbudd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Generally looks good to me, thanks @XLTechie

Comment thread user_docs/en/userGuide.t2t Outdated

@Qchristensen Qchristensen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Just one small suggestion (Change "a list with several configuration categories", to "a list of configuration categories" - since there are more than "several" now. Otherwise, all good.

Comment thread user_docs/en/userGuide.t2t Outdated
XLTechie and others added 2 commits May 31, 2023 04:45
…eral" from number of categories.

Co-authored-by: Quentin Christensen <quentin@nvaccess.org>
Co-authored-by: Sean Budd <seanbudd123@gmail.com>
@seanbudd seanbudd merged commit a210e37 into nvaccess:master Jun 1, 2023
@nvaccessAuto nvaccessAuto added this to the 2023.2 milestone Jun 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Give information on changing settings categories in NVDA's settings dialog

4 participants