Re: Doc for multiple interfaces -Related Question

Subject: Re: Doc for multiple interfaces -Related Question
From: Bill Sullivan <bsullivan -at- SMTPLINK -dot- DELTECPOWER -dot- COM>
Date: Fri, 25 Apr 1997 11:23:18 -0700

>A related question -- how would you handle documenting a product
where the customer can choose the work flow, thus changing the
interface on the fly?

You show customers A and B performing 5 identical steps in different
sequences. The "Checking if the customer owes past-due invoices" step
occurs in different places in each sequence.

I would number the steps from 1 to 4 and either insert the past-due
invoice check as an OPTION which could be done after step 1 or step
3, or else put "Checking for past-due invoices" as a separate
procedure.

If it is not important that the steps (except releasing the order) be
performed in order, you could call your procedure "Completing the
Configuration Form" and merely list the steps without numbering them.
Or, step 1 could be "Complete the Form," with a list of the elements
that comprise completing the form, and step 2 could be (Release the
Order."

Come to think of it, I like this best. Make it a two-step procedure
and not a 4- or a 5-step procedure.

Bill Sullivan
bsullivan -at- deltecpower -dot- com
San Diego, California

TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html


Previous by Author: Re: Anyone heard of this Tufte guy? -Reply
Next by Author: Trademarks for Other Companies' Products -Reply
Previous by Thread: Re: online help reviews
Next by Thread: Pricing Documents


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


Sponsored Ads