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:"Kathleen" <keamac -at- cox -dot- net> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Sun, 15 May 2005 07:29:35 -0700
Carrie,
I'd leave "click Ok" in, primarily because it completes the stage/steps,
but a lot of people don't. I don't usually document the Help or Cancel
buttons.
But I'm wondering if there might be something more important to be
thinking about in those documents than removing the OK/Cancel
instructions. Unless you're trying to get a feel for how to write new
documentation or following instructions for cleaning up legacy material,
removing the OK/Cancel instructions seems to be make-work to me. And
there's usually a lot of work that could be done to make previous
material clearer and/or update it to current revisions. I'd suggest
working through the steps to verify they're complete and account for the
appropriate situations. Also check the screen shots for accuracy (and
spelling)--they can change in a flash w/o anyone remembering to tell the
tech writer.
Kathleen
-----Original Message-----
From: Carrie Baker
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.
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.
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.
