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:FW: Appendix within a chapter. From:Bill Fetzner <BFetzner -at- ETCCONNECT -dot- COM> Date:Tue, 29 Jun 1999 09:24:23 -0500
John ~ In view of these three constraints, I'd be inclined to present the
alternatives together and in parallel form for each such situation. For
example, if you're talking about feature X and category 1, 2, and 3 ways to
use it, I would headline feature X and have three sections below it for the
three categories, with an introduction under the headline that explains
which is most common, which is best for certain situations, etc. This way
you avoid Frame's advanced features as you wish and don't get bogged down in
Word with cross-referencing.
If you can identify parts of the categories that are common among many
features, perhaps could throw those into a chapter or end appendix and
reference those nuggets to minimize redundancy and try to speed things along
for the reader.
> From: John Posada
> Reply To: John Posada
> Sent: Monday, June 28, 1999 8:23 PM
> To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
> Subject: Re: Appendix within a chapter.
> Three problems with this, in this particular
> 1) The "sub-procedure" might be 2-5 pages long, just
> by itself, including cross-references and referenced
> graphics (screen shots).
> 2) I'm working in Frame 5.5.6, but I'll be delivering
> the manual in Word, converted by mif2rtf. Therefore,
> I'm using as few Frame advanced features as possible.
> 3) There is alot of redundant functionality in the
> application (the same procedure might stem off of a
> menu icon and also a submenu of a text menu). Keeping
> it a separate discrete section of text, I can place
> the line "See Section x on page y for details on ..."
> whenever I need.
> > Try a long endnote.
> > HTH
> > Peter
> > John Posada wrote:
> > >
> > > I want to do something "different" and I was
> > wondering
> 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=