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.
Subject:Re: Another Newbie question about procedures From:John Posada <jposada01 -at- yahoo -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 16 May 2005 07:19:33 -0700 (PDT)
> When writing a procedure, can you presume that users know that the
> last stage is Click OK to confirm your settings,
> or should you tell them this.
The step for OK isn't for the purpose of letting them know what the
OK button is for...it is the step that tells them the proceess
described previously is concluded.
> Furthermore, should one tell them click Cancel to leave the screen.
> These sentences appear in our existing user guide.
> For every screen in our guides it tells you that you should click
> OK
> to confirm choices and Cancel to leave the screen without changing
> anything (i.e. it explains/documents the cancel and OK buttons).
>
> In light of posts I have read here, I was wondering whether these
> explanations are too obvious and therefore redundant.
> The users are experienced computer personnel.
It has nothing to do with level of competency..it has to do with flow
John Posada
Senior Technical Writer
?Never be afraid to try something new. Remember that a lone
amateur built the Ark. A large group of professionals built
the Titanic.? - Dave Barry
New from Quadralay Corporation: WebWorks ePublisher Pro!
Completely XML-based online publishing. Easily create 14 online formats, including 6 Help systems, in a streamlined project-based workflow. Word version ships in June, FrameMaker version ships in July. Sign up for a live, online demo! http://www.webworks.com/techwr-l
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
