RE: Features of a well-written procedure

Subject: RE: Features of a well-written procedure
From: Sanjay Srikonda <SSrikonda -at- invlink -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 18 Dec 2000 10:08:25 -0500

I write software that took over 5 years to write and develop and well, is
not as intuitive as most software. By this I mean that not all the steps to
get to the end result are on the same screen or screens. Some are quite
disparate and were placed catch-as-catch-can anywhere the programmer
believed they belonged. I've written over 25 step procedures, but what I
ended up doing whas breaking them up into tasks to be performed. Sort of
like a checklist. You do this bit and then you move on to the next bit. I
found it a good way to keep the rhythm of things as well.

-----Original Message-----
From: Philip Boyer [mailto:pboyer -at- dimasys -dot- com]
Sent: Monday, December 18, 2000 10:13 AM
To: TECHWR-L
Subject: RE: Features of a well-written procedure


Mike wrote: "The justification for the five-to-seven rule
has never made sense to me, because it seems based on research about
memorization, which isn't relevant. Perhaps others who know the research
better will chime in..."


I don't know the research, but a rule I follow unless I absolutely have to
break it is to keep the number of steps at 9 or less. If I'm going over 9, I
see if I can combine any steps. Or, if I have enough steps and a clear
breaking point, I'll create two or more procedures. I don't know if Robohelp
manuals still do this, but their 25+ step procedures used to drive me crazy.

Philip
<snip>

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY.
http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.

Take XML and Tech Writing courses online! Our instructor-led courses
(4-6 hrs/wk) give you "hands on" experience at your convenience. STC members
get 20% off! http://www.online-learning.com/index.html.
---
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.


Previous by Author: RE: Displays versus Appears-Which One?
Next by Author: Can someone explain or point me to a good resource to explain Ali ases?
Previous by Thread: RE: Features of a well-written procedure
Next by Thread: RE: Features of a well-written procedure


What this post helpful? Share it with friends and colleagues:


Sponsored Ads