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: Time to perfom a procedure From:"Carey Jennifer (Cry)" <jennifer -dot- carey -at- cdi -dot- cerberus -dot- ch> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 15 Apr 2002 13:47:15 +0200
Raju
I think your point is a good one. Much of the "art" or "skill" of writing an
effective manual is knowing what *not* to say. In fact, I still need to
consider whether this information might be useful or completely unnecessary
in my own documentation.
But I do think that in John's case, especially given the audience, it would
be valuable to keep them motivated to finish. So, if it's a 6-phase process,
letting them know where they are time-wise could be really useful.
The scenario I think about is this:
Imagine that we don't include the times in the document.
Time: 13:30 - Joe the executive sits down 30 minutes before lunch to do the
process, so you and I know that he has just enough time to get through it
all. What Joe doesn't know is that, a) it should take exactly the amount of
time he has availble, and that of those 30 total minutes, phases I and II
take by far the longest.
Time: 13:50 - Joe's now 20 minutes into the process and still in phase II
when his colleague Bob calls to ask him to go to lunch in 10 minutes. Joe
sees he's only in phase II of VI and thinks "wow, this has taken 20 minutes
and I'm only in phase II. I don't have an hour to do this thing. I'll have
to do it another time." Realistically, Joe won't set aside that time until
some other situation necessitates his performing it.
If Joe knew that phases III-VI will only take 10 more minutes, he would see
the obvious value in finishing the project now even if it means going to
lunch 5 minutes late...
I don't doubt that there might be a scenario that argues against including
the time and would be interested to hear it if you have one...thoughts?
The idea of including the time a process should take is really *fantastic*,
but there is a possibility that it might lead to certain unwanted
side-effects.
The grasping of human mind is varying, depending on the approach an
individual takes to the process of learning. So, fixing a time frame will,
undoubtedly, surface some personality traits and might lead to either
under-estimation of over-estimation of the content presented.
Under-estimation leads to degrading the concept, and over-estimation leads
to inferiority complex. In something that is professional, why bring
anything that will affect the process ?
Raju
--------------------------
Jennifer wrote:
To answer your question, I haven't ever included the time a process should
take, but I think it's a *fantastic* idea and would consider doing it
wherever appropriate (relevant, useful) in my own documentation. I also
think explaining that this is a one time procedure and will take 20-30
minutes is a good thing to include in the text right before the procedure.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Are you using Doc-to-Help or ForeHelp? Switch to RoboHelp for Word for $249
or to RoboHelp Office for only $499. Get the PC Magazine five-star rated
Help authoring tool for less! Go to http://www.ehelp.com/techwr
Free copy of ARTS PDF Tools when you register for the PDF
Conference by April 30. Leading-Edge Practices for Enterprise
& Government, June 3-5, Bethesda,MD. www.PDFConference.com
---
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.