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:Michele Marques <msmarques -at- rogers -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 16 Apr 2002 07:27:07 -0400
John wondered:
> What I would like to know is if anyone has ever included in the
> document the amount of time that an average user from the targeted
> audience should be able to perform the process.
When I write about systems or servers that are used by a number of
people concurrently (e.g. ERP systems), I try to include a time estimate
when documenting procedures that require the system or server to be
unavailable to most users. For example, when describing the procedures
to upgrade the system to the next version or describing disaster
recovery procedures, it is useful to include a time estimate, so that
the reader knows how much (longer) the system will be unavailable to
most users - and if it is for a planned activity, can plan an
appropriate time to schedule the activity. This time estimate is never
how much time the average user should take, but a reasonable maximum
time to allow (e.g., allowing for the slowest recommended system,
someone working slowly, etc.) - the reader is unlikely to complain about
the procedure being completed ahead of schedule but could have problems
if the procedure takes longer to complete than planned (especially if
the system is critical to business operations).
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.