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: Appendix within a chapter. From:Svi Ben-Elya <svi -dot- ben-elya -at- AKS -dot- COM> Date:Tue, 29 Jun 1999 14:12:43 GMT
Can you prepare a short step by step procedure that does not go into
detail, then follow with more detailed procedures of each step.
For example:
Overview procedure
Step 1: Configure the restart option
Step 2: Define the timeout
Step 3: . . .
.
.
.
Configuring the restart option
This option allows you to . . .
Step 1: . . .
Step 2: . . .
.
.
.
Defining the timeout
The timeout determines how long the XXX program waits for a response from
YYY. Once this amount of time passes without a response the restart
operation is performed.
Step 1: . . .
Step 2: . . .
.
.
.
On 6/28/99 11:32:36 PM John Posada wrote:
>
>I want to do something "different" and I was wondering
>if anyone has attempted this.
>
>The software developers on my application (bless their
>heart) tried to make the application so cutomizable
>that they've made it almost impossible to configure
>for anyone with experience short of developer level.
>This happend by attempting to incorporate every wish
>of every user, even if only one out of a hundred users
>had that wish. Therefore, one of the problems is that
>almost every dropdown box (and there are MANY) can be
>customized.
>
>In trying to address a process in the document at the
>time that it would occur in the application, the
>procedure gets bogged down in side-processes that
>makes the average user deviate from the normal
>procedure.
>
>Therefore, I'd like to group the side-processes in a
>section at the end of each chapter. In this way, if an
>advanced user wants to address some of the
>configuration cababilities that most users wouldn't
>care about, they can reference the procedure at the
>end of the chapter.
>
>I realize that this description probably doesn't do
>the problem justice, but based on my description, does
>this seem like a totaly bizzare way of addressing it?
>
>===
>John Posada
>Western Union International
>(w) jposada -at- westernunion -dot- com
>(p) john -at- tdandw -dot- com
>_________________________________________________________
>Do You Yahoo!?
>Get your free @yahoo.com address at http://mail.yahoo.com
>
>
>
From ??? -at- ??? Sun Jan 00 00:00:00 0000=
>
>
____________________________________
Svi Ben-Elya
svib -at- aks -dot- com
chase -at- netvision -dot- net -dot- il
_____________________________________