RE: On-line vs. print (WAS: Of myth and reality)?

Subject: RE: On-line vs. print (WAS: Of myth and reality)?
From: "Ed Manley" <edmanley -at- bellsouth -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 1 Aug 2002 15:34:48 -0700

Yes, Eric, I am vitally interested in the things you mention.

As to the similarity / difference issue re using the same source files for
online and print - It seems to me that one would reuse where possible, keep
separate artifacts where not. I can't see why the question requires too much

At the other end of the "lost in hyperspace" topic is the issue of
modularizing topical documentation and storing it in some logical fashion -
a content repository or database. I can see how all of this will work except
for that part - without some huge Content Management system I don't know how
I would keep track of all the bits and pieces.

As example, a User Guide, where I have numerous topics, screen shots,
tables, etc.

If I keep each object as an artifact - a separate file, how am I going to
organize/manage them? I can see the beauty of building the online or printed
guide by calling the objects in some logical order...but we're talking
hundreds of discrete files to manage.

I am really fired up about this, but can't wrap my mind around how a writer,
or perhaps more importantly a maintenance coder, analyst or manager that
needs to make a change to a screen shot and its accompanying text, is going
to find those files.

Any suggestions?

>> Well, this subject certainly didn't garner much interest did it? After so
claiming that on-line and print are so different, is there nobody willing to
discuss the requirements of on-line documentation?

I didn't want this thread to touch single sourcing, I wanted to honestly
the differences and similarities in the requirements of each type of
documentation and how those requirements might be addressed.

Geoff Hart pointed out the issue of being 'lost in hyperspace' an issue that
would think requires further study. How can the user be kept 'in context'
drilling around in on-line documentation?

Or, in printed documentation how do you best present detailed information
still allow the user to quickly find procedural instructions that don't
they've read the whole book?

Eric L. Dunn

Buy RoboHelp Deluxe starting at only $798: you'll get RoboDemo, the hot new
software demonstration tool that's taking the Help authoring world by storm,
together with RoboHelp Office. Learn more at

Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.

You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit for more resources and info.


Re: On-line vs. print (WAS: Of myth and reality)?: From: eric . dunn

Previous by Author: Help on Delphi HelpIDs
Next by Author: RE: About proprietary writing samples
Previous by Thread: RE: On-line vs. print (WAS: Of myth and reality)?
Next by Thread: Re: On-line vs. print (WAS: Of myth and reality)?

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

Sponsored Ads

Sponsored Ads