Skip to content

Proposed revisions to add-on store user guide subchapter#14966

Merged
seanbudd merged 24 commits into
nvaccess:masterfrom
XLTechie:addonStore_guide_revisions
Jun 6, 2023
Merged

Proposed revisions to add-on store user guide subchapter#14966
seanbudd merged 24 commits into
nvaccess:masterfrom
XLTechie:addonStore_guide_revisions

Conversation

@XLTechie

@XLTechie XLTechie commented Jun 6, 2023

Copy link
Copy Markdown
Collaborator

Note: this was originally presented in PR #14961

Link to issue number:

Part of #13985

Summary of the issue:

After reading the proposed add-on store user guide sections, I thought they could be more user friendly. The current form appeared to assume more knowledge than the user may have.

Description of user facing changes

The following summarizes the changes I made to each section.

Add-on Store:

  • Rewrote introductory section to better explain what add-ons are.
  • Explained that it being a "store" does not mean users must pay.

Browsing add-ons:

  • Better explained the use case for alt+l.
  • Explained what "selecting an add-on" means.
  • Elaborated a bit more on actions.

Add-on list views:

  • Changed the sentence order to be more logical.
  • Noted the possibility of view changing via arrow keys.

Include incompatible add-ons:

This heading was duplicated.
Changed the first one to "Filtering for enabled or disabled add-ons".

Filtering for enabled or disabled add-ons:

Wrote a substantive introductory section, explaining enabled/disabled states.

Include incompatible add-ons:

Minor grammar.

Filter add-ons by channel:

  • Slightly more explanation for beta add-ons.
  • Moved explanations before usage instructions.

Search add-ons:

  • Changed title to "Searching for add-ons".
  • Added instructions on how to reach the search field.
  • Removed the line "Add-ons can be filtered by display name, publisher and description.", because there are no instructions on how to do that. Expect to add back in later, after that part can be more easily explained.

Add-on actions:

Made the instructions more complete.

Installing add-ons:

  • Added an NV Access disclaimer at the top.
    • I Used the word "vetted", because that has been used to describe NV Access accepting add-ons into the store, by some members in the community, and I wanted to make clear that they are not "vetted" in any way by NV Access.
  • Slight clarifications.
  • Removed a rogue space at the end of a line.

Removing Add-ons:

Minor word change to avoid proximate word repetition.

Disabling and Enabling Add-ons:

Changed "a status" to "the status", since the cases are specific.

Incompatible Add-ons:

  • Suggested grammar changes for better flow.
  • Added potential reasons why a user may want to disable all add-ons.

Description of development approach

Tried to read as a less technical user.

Testing strategy:

Preferred review from @Qchristensen

Known issues with pull request:

Change log entries:

Code Review Checklist:

  • Pull Request description:
    • description is up to date
    • change log entries
  • Testing:
    • Unit tests
    • System (end to end) tests
    • Manual testing
  • API is compatible with existing add-ons.
  • Documentation:
    • User Documentation
    • Developer / Technical Documentation
    • Context sensitive help for GUI changes
  • UX of all users considered:
    • Speech
    • Braille
    • Low Vision
    • Different web browsers
    • Localization in other languages / culture than English
  • Security precautions taken.

Luke Davis added 18 commits June 5, 2023 21:55
…e first one to "Filtering for enabled or disabled add-ons".
…uctory section, explaining enabled/disabled states.
…. Moved explanations before usage instructions.
…isplay name, publisher and description.", because there are no instructions.
…", because that has been used to describe NV Access accepting add-ons into the store, by some members in the community, and I wanted to make clear that they are not "vetted" in any way.
@XLTechie XLTechie marked this pull request as ready for review June 6, 2023 02:03
@XLTechie XLTechie requested a review from a team as a code owner June 6, 2023 02:03
@XLTechie XLTechie requested a review from Qchristensen June 6, 2023 02:03

@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.

Thanks @XLTechie, these changes generally look good to me.

Comment thread user_docs/en/userGuide.t2t Outdated
Comment thread user_docs/en/userGuide.t2t Outdated
Comment thread user_docs/en/userGuide.t2t
Comment thread user_docs/en/userGuide.t2t Outdated
Comment thread user_docs/en/userGuide.t2t Outdated
Comment thread user_docs/en/userGuide.t2t Outdated
XLTechie and others added 4 commits June 5, 2023 23:08
Co-authored-by: Sean Budd <seanbudd123@gmail.com>
Co-authored-by: Sean Budd <seanbudd123@gmail.com>
…red by display name, publisher and description.", because there are no instructions.'

This reverts commit a53058b.
… and wording of gesture assignment suggestion.
Comment thread user_docs/en/userGuide.t2t Outdated
Comment thread user_docs/en/userGuide.t2t Outdated
XLTechie and others added 2 commits June 5, 2023 23:40
Co-authored-by: Sean Budd <seanbudd123@gmail.com>
…y display name, publisher and description.", per review.

@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.

Thanks @XLTechie

@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.

Reads well, thank you!

@ruifontes

Copy link
Copy Markdown
Contributor

@seanbudd, by instance the Vocalizer driver add-ons are free.
User should buy the license to use the voices, but downloading and installing is free.
Can we include those add-ons on the add-on store?

Tiflotecnia, Lda.

@seanbudd

seanbudd commented Jun 7, 2023

Copy link
Copy Markdown
Member

@ruifontes - yes. In that case, the add-on is free, but you are paying for a separate component.
NV Access just has no plans to support payments on the add-on store platform at this stage.

@XLTechie

XLTechie commented Jun 7, 2023 via email

Copy link
Copy Markdown
Collaborator Author

@seanbudd

seanbudd commented Jun 7, 2023

Copy link
Copy Markdown
Member

@XLTechie maybe an added sentence could help.

"Some free add-ons require a purchase of external software to work, such as commercial synthesizers."

@ruifontes

Copy link
Copy Markdown
Contributor

@seanbudd and @XLTechie thanks!
@seanbudd I think the sentence:
"Some free add-ons require the purchase of a license or external software to work, such as commercial synthesizers."

will be better...

@XLTechie

XLTechie commented Jun 7, 2023 via email

Copy link
Copy Markdown
Collaborator Author

@seanbudd

seanbudd commented Jun 7, 2023

Copy link
Copy Markdown
Member

Could you raise that suggestion as a separate issue? I think it's worth discussing further

seanbudd pushed a commit that referenced this pull request Jun 9, 2023
…of free add-ons with paid components (#14982)

Consideration of the language to use in the User Guide, when describing all add-ons as free in the store, while certain add-ons require the purchase of components or licenses in order to do anything.

Description of user facing changes
Revised language.

Description of development approach
Edited the language to be more in line with the comments in #14966. It may still not be as desired, but this provides a context to revise it in.
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.

5 participants