Repeating blocks of text: How (or if?) in unstructured FM

["Joe Malin" <jmalin -at- tuvox -dot- com>]

Hi!

 

I always seem to hit this issue:

 

I have several similar procedures for creating a new software
application in the IDE. The user chooses a procedure based on the
template he or she is using as a start. In each procedure, the user
follows a path based on what results he or she wants.

 

The procedures share a lot of steps, but some are different. For
example, if I have three procedures, they have the following pattern.
Notice that some steps are common to all three procedures, but I write
them out three times:

 

Procedure 1:

Step A1

Step B

Step C

Step D1

Step E1 or E2

Step F1

 

Procedure 2:

Step A2

Step B

Step C

Step D1

Step E1 or E3

Step F2

 

Procedure 3:

Step A2

Step B

Step D1

Step E2 or E3

Step F1

 

I write out all three procedures in their entirety, because as much as
possible I want the user to see all the steps in one place, without
jumps around the documents.

 

Does this make sense? Would it be somehow better to craft one procedure
with various options? Three procedures that "thread" through the steps,
so that I write each step only once?

 

If I put a common step (for example Step B) three times, what's the best
way to do it in FM? Should I use text insets?

 


TuVox, Inc.


19050 Pruneridge Avenue Suite 150, Cupertino, CA 95014-0715

Joe Malin

Technical Writer

(408)625.1623

jmalin -at- tuvox -dot- com

www.tuvox.com

The views expressed in this document are those of the sender, and do not
necessarily reflect those of TuVox, Inc.

 

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot- 

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to lisa -at- techwr-l -dot- com -dot-  Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.