Re: Document Planning

[Tim Glasheen <2528 -at- MN3 -dot- LAWSON -dot- LAWSON -dot- COM>]

What I am wondering is whether or not I should repeat information that is
the same for each flavor in every section, or should I write it once and
make reference to it in the other sections. And if I do write it once, in
which section should I write it (i.e., the most complicated flavor or the
least complicated)?


I am actually in the same situation. I have several procedures that are
reletavily the same.
Here's what I think. I never assume. When I am doing a procedure, I look in
the TOC for what I have to do and go there, not looking at other information
and not wanting to. This also helps for reference.  Users may find a way
they like or want to use often, and the first couple times they are
becomming familiar with that process they want that information in front of
them. I also like to reduce flipping. I personally hate to do that, biggest
pain in the butt to have to flip all over the place to find out what to do.
UNLESS, the procedures are all the same (which I doubt from your message).
Then, and only then, would I include them all under one heading.
Hope this is clear, I'm in kinda a crunch right now.

 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