Where would someone send comments about the user guide?  Is there a
group that works on it?  I don't think Github is intended for that purpose.

Gene

Hi Gene

It depends on what you want to comment about user guide.

If you want to have a specific issue fixed in the user guide, GitHub is adapted. Examples of specific issues may be:
- NVDA+shift+control+F1 command does not appear in the User Guide
- Add a paragraph explaining how to make a donation to NVAccess
- etc.

For broader topics, such as "The User Guide should contain some native Windows shortcuts (e.g. Windows+B to go to systray)", you'd better to discuss here. Once you get something more specific, you can open a GitHub ticket for this. For example, you would open a ticket when you are able to provide answers to the following questions:
- Which native Windows shortcuts/commands should be added and which not? E.g. Windows+B, control+C, alt+F4, right arrow in an edit field, tab to move the focus.
- Which criterion do you use to decide if a native Windows command needs to be added in the User Guide or not?
- Is this information available elsewhere (e.g. Basic training of NVAccess, Microsoft website, elsewhere on the web)? If yes, why is it not enough?
- Is there an alternative to this request, e.g. include NVAccess training material in NVDA? (I imagine that they won't accept this request but having an explicit answer is important)
- etc.

Cheers,

Cyrille

On Wed, Feb 8, 2023 at 09:15 AM, Gene wrote:

Where would someone send comments about the user guide?  Is there a
group that works on it?  I don't think Github is intended for that purpose.

Gene

Gene wrote:

Are the questions you say should be answered in the feature request section?  I just recall that section dealing with features in NVDA itself and not in the
user manual.

Gene, there's no need to be so literally minded.  The vast majority of feature requests/bug reports are specific to the software. There is not a separate documentation template to be filled out.

But the user guide *is* a part of the software.

Even though the phrasing may be geared toward software features, I'm sure your mind is flexible enough to cast the template questions in a way that is compatible with documentation.

You can figure out "why" their asking those questions in relation to software features. So try to answer the same "why" questions, as if they had been phrased in a way so as to apply to the documentation.

Also look at the pull request template, as any changes to the documentation will be filtered through that next. Especially the section at the end with the checkboxes for developers. The testing stuff doesn't apply, but the user experience stuff certainly does, if looked at a certain way.

Luke

I asked the question because the person making the comments posed very
specific questions that might be posed in a template.  I'm not saying I
can't work with the new features template, I have, but the questions
were so specific that I didn't know if that is whet he is referring to.

Gene

On 2/8/2023 3:35 AM, Luke Davis wrote:

Gene wrote:

Are the questions you say should be answered in the feature request
section?  I just recall that section dealing with features in NVDA
itself and not in the
user manual.

Gene, there's no need to be so literally minded.  The vast majority of
feature requests/bug reports are specific to the software. There is
not a separate documentation template to be filled out.

But the user guide *is* a part of the software.

Even though the phrasing may be geared toward software features, I'm
sure your mind is flexible enough to cast the template questions in a
way that is compatible with documentation.

You can figure out "why" their asking those questions in relation to
software features. So try to answer the same "why" questions, as if
they had been phrased in a way so as to apply to the documentation.

Also look at the pull request template, as any changes to the
documentation will be filtered through that next. Especially the
section at the end with the checkboxes for developers. The testing
stuff doesn't apply, but the user experience stuff certainly does, if
looked at a certain way.

Luke