TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
..> Many windows-based software applications provide at least two ways of
doing
> things, one by keyboarding, one by point-and-click. To be thorough,
> accurate, and address the needs of users who prefer one method over the
> other, the Technical Communicator should be documenting mouse and keyboard
> procedures, if both exist....
Now I didn't say I don't document the procedures, I said I do not refer to
the DOS insertion point and the Mouse Pointer/Cursor. If you write
'actively' you will soon discover that you do not use such terminology. You
wouldn't tell a typist how to press a key or a shorthand secretary how to
use a pen - would you?
..> Another example: If you are documenting an application for users who
are not
> Windows literate, you may also need to be very specific about when to use
> the mouse, and when to use the keyboard. ...
When writing for users who are new to Windows, you should refer them to
Windows help or other O/S documentation. The operating system writers are
better equiped to instruct the user on their platform. After all, do your
developers re-create the Print dialog, or do they use the one supplied by
the O/S?