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.
> If you write a procedure that ends in the user having to
> click OK to save or has the option of clicking Cancel to
> cancel everything, do you include the both in your instruction?
Your procedure tells how to complete a task--not how to bail out of it. (Not
that there's anything wrong with bailing out of it...) Assuming that the Cancel
button works as it does in other applications, I would omit "Cancel" from the
instructions. There are few things we can assume users already know, but I think
the Cancel button is one of those things.
On the other hand, if Cancel does something weird--e.g., if some changes are
saved instead of discarded, or if you have to click Cancel to return to a
previous menu/screen AFTER completing your task--then you'd better document it.
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
Check out RoboDemo for tutorials! It makes creating full-motion software
demonstrations and other onscreen support materials easy and intuitive.
Need RoboHelp? Save $100 on RoboHelp Office in May with our mail-in rebate.
Go to http://www.ehelp.com/techwr-l
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.