MobileRead Forums - View Single Post - Wanted: Volunteers to Update the Sigil User's Guide

BetterRed · 01-01-2017, 07:28 PM

Whilst using the manual I've occasionally stumbled on instances where To do [whatever] click the [whatever] button is not augmented by or select the menu item [whatever] or its keyboard shortcut.

I don't have any tool bars displayed so there are no buttons to click, I can usually guess where the menu item is, but sometimes not.

I'm pretty sure I have also seen instances where explicit keyboard shortcuts are mentioned - F7 comes to mind. Given most keyboard shortcuts are user configurable this seems wrong to me, the keyboard shortcuts have names, so why not use them.

I also find the manual both verbose and imprecise, a common shortfall in documents of this ilk. Apart from the authors and copy editors, people don't read manuals as one might read a newspaper or a novel, they refer to them to get instruction on how to do something. Here's an example, of what's there and what I suggest is a better alternative

BR

01-01-2017, 07:28 PM	#28
BetterRed null operator (he/him) Posts: 21,833 Karma: 30277270 Join Date: Mar 2012 Location: Sydney Australia Device: none	Whilst using the manual I've occasionally stumbled on instances where To do [whatever] click the [whatever] button is not augmented by or select the menu item [whatever] or its keyboard shortcut. I don't have any tool bars displayed so there are no buttons to click, I can usually guess where the menu item is, but sometimes not. I'm pretty sure I have also seen instances where explicit keyboard shortcuts are mentioned - F7 comes to mind. Given most keyboard shortcuts are user configurable this seems wrong to me, the keyboard shortcuts have names, so why not use them. I also find the manual both verbose and imprecise, a common shortfall in documents of this ilk. Apart from the authors and copy editors, people don't read manuals as one might read a newspaper or a novel, they refer to them to get instruction on how to do something. Here's an example, of what's there and what I suggest is a better alternative BR Last edited by BetterRed; 01-01-2017 at 07:32 PM.