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:Re: Building a web site for documentation From:"Christensen, Kent" <lkchris -at- sandia -dot- gov> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 25 Sep 2001 14:50:45 -0600
re: All graphics (and there are many) will be reduced in size, with an
option to expand each one. ("Click to expand," or somesuch.) Shrinking the
graphics saves loading time for users.
Saving loading time depends on how it's done. One way is to have two
graphics files for each image. First file is the small one and second is
the big one. Many times, however, the small screen display is just the
large one resized smaller using IMG WIDTH and IMG HEIGHT properties. This
means the entire file loads and another file load is not required for the
"click to expand" process. At some point this is the method that saves load
time, especially if you're pretty sure the user will very likely want to
view the larger graphic.
Since there are "many" graphics, best way to save loading time is not to
make the entire 400-page FrameMaker file into a single html file. Probably
each and every "section" that becomes an html file needs a printer-friendly
version. I think it's naive to suggest users won't want to print. Suggest
pdf for this (only).
re: .. this plan does NOT involve converting Frame to HTML. ... We copy the
text and paste it into DreamWeaver, then reformat it for usability in a
browser.
This is just semantics and not accurate. The document is being saved as
html by DreamWeaver, and the process then essentially is a conversion to
html. However you do it and whatever you call it, online presentation using
html is nevertheless the best way to go IMHO. PDF is for the
printer-friendly version only and not for the screen viewable version.
These versions are apples and oranges to those who would optimize the
reading experience for each instance.
re: (it's a "workbook")
Sounds like there is opportunity for interactive testing or coaching. This
of course doesn't automatically happen using copy/paste, Dreamweaver, etc.
Be sure adding interactivity is extensively described in your plan. Plan on
time/expense for testing the interactivity.
Conclusion: Your users have seen it before and are spoiled. They want all
the bells and whistles they've already seen and will judge your product
poorly if they don't get them. Given this notion, suggest considering your
existing FrameMaker product merely the outline for your planned online
interactive product.
"Conversion" using tools is in most of these instances just a euphemism for
"quick and dirty" and brings to mind the notion of (not) doing it right the
first time. Not doing it right the first time, i.e. doing it over, may
seriously erode your savings from eliminating printing and distribution
costs.
Planning to attend IPCC 01, October 24-27 in Santa Fe? Sign up by
October 3 and get a substantial discount! Program information,
online registration, and more on http://ieeepcs.org/2001/
+++ Miramo -- Database/XML publishing automation. See us at +++
+++ Seybold SFO, Sept. 25-27, in the Adobe Partners Pavilion +++
+++ More info: http://www.axialinfo.comhttp://www.miramo.com +++
---
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 http://www.raycomm.com/techwhirl/ for more resources and info.
