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.
So, how do y'all deal with documenting several different ways of
accomplishing the same task?
Response:
I only document one method, giving preference to the simplest and most
versatile. I prefer to document menu selections ("From the File menu, select
Open.") because the user can access them with either the keyboard or the
mouse. I encourage the developer to use standard GUI buttons and label them
or use "tool tips," so that users who like to click buttons can easily
discover these alternatives. I also include tables with buttons and keyboard
shortcuts, if necessary.
