User Manual bugs?
Henri Yandell
Looking at the recent one, the following jump out:
P4. The picture has no arrow pointing to the little circle in the top middle.
P4. The picture has left and right arrows. I'd expect it to say
'Previous category' and 'Next category', but I can see that 'Change
category' is simpler.
P5. Same directional issue when discussing the up and down arrows. Is
there a preferred direction to listen to content in?
P5. Middle of page: "press the left arrow < or left arrow >" should
be right arrow for the 2nd.
P6. Item #3 of How to delete a message is missing a closing ".
P6. "find the find the".
P7. use the left and right arrows: The ( < or > ) should probably be
( < and > ). ie) match the 'and' from before.
P8. The hyperlink item refers to 'hidden audio' without defining this.
Might be better to refer to the already explained concepts of
'definition of a word' or 'further information'.
I'm going to stop there in case this is out of date content :)
Hen
Cliff Schmidt
Thanks for the user manual review! Because you took the time to do
this, I finally added the manual to our subversion repository. It's
now in http://literacybridge.googlecode.com/svn/device/docs/. I also
added a "best practices guide" to the same directory.
More answers below.
On Mon, Feb 20, 2012 at 10:52 PM, Henri Yandell <he...@yandell.org> wrote:
> Where do we report bugs in the User Manual?
There is no place right now, but would you like to start a Jira
project for this? Rich and Noirin are two other volunteers who have
tons of doc experience and have offered to help with docs before.
They may have other ideas about how to report bugs, but I would say
that if you don't hear anything from them or anyone else, I encourage
you to do whatever you think makes the most sense for now, so that we
can have some process working.
> Looking at the recent one, the following jump out:
>
> P4. The picture has no arrow pointing to the little circle in the top middle.
That little circle represents the green/red LED. I suppose we can
remove it or add text that explains that.
> P4. The picture has left and right arrows. I'd expect it to say
> 'Previous category' and 'Next category', but I can see that 'Change
> category' is simpler.
Thanks, I like you suggestion, and I've made the change and updated
the doc in the repository
(http://literacybridge.googlecode.com/svn/device/docs/Talking%20Book%20User%20Manual.docx)
> P5. Same directional issue when discussing the up and down arrows. Is
> there a preferred direction to listen to content in?
Thanks again -- I made the same change to the diagram on page 4. I've
also tried to clarify the description on page 5.
> P5. Middle of page: "press the left arrow < or left arrow >" should
> be right arrow for the 2nd.
Fixed. Thanks!
> P6. Item #3 of How to delete a message is missing a closing ".
Fixed. Thanks!
> P6. "find the find the".
Fixed. Thanks!
> P7. use the left and right arrows: The ( < or > ) should probably be
> ( < and > ). ie) match the 'and' from before.
Fixed. Thanks!
> P8. The hyperlink item refers to 'hidden audio' without defining this.
> Might be better to refer to the already explained concepts of
> 'definition of a word' or 'further information'.
Good point. Fixed.
> I'm going to stop there in case this is out of date content :)
These were all great points, Hen! The only change I didn't make was
the first one (no reference to the LED) . See my thoughts on that
above and let me know what you think is best. You can see all the
other changes made here:
http://literacybridge.googlecode.com/svn/device/docs/Talking%20Book%20User%20Manual.docx.
(under svn revision r822:
http://code.google.com/p/literacybridge/source/detail?r=822)
And let me know if you would like commit access to this doc so you can
make any other changes you find yourself!
Cliff
Henri Yandell
I don't think it hurts to explain the green/red LED. Is it a power
light? General status indicator?
Hen