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: Documentation on the Web From:"Christensen, Kent" <lkchris -at- sandia -dot- gov> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 25 Jan 2002 07:26:16 -0700
re: I was wondering if anyone can recommend web sites to look at for ideas
on placing documentation on the web. We are trying to place documentation
updates on the web in PDF or some other type of format. (Julie Nelson)
Placing "documentation" on the Web is like placing anything else on the Web.
Therefore, any list of general tips will generally serve, including those at http://www.useit.com/alertbox/ and especially the article there "Avoid PDF
for On-screen Reading."
First thing to decide is if your main goal is just to provide a file
transfer mechanism--that is, your users will simply print the
"documentation" and read from printed matter--or whether users will indeed
perform tasks or learn while reading from the screen. PDF is a great file
transfer mechanism, but HTML is the way to go if material will mostly be
read from the screen. <grin>Use Verdana font for screen reading, use Times
for printed matter.</grin> Make smaller "chunks" for screen reading than
you do for printing. If you think your users will do both, make HTML pages
with "printer-friendly version" links, i.e., do it right the first time.
Attention ForeHelp and Doc-to-Help Users! Upgrade your existing product to
RoboHelp for only $299, through January 31st. RoboHelp can import your
existing Help projects! Learn how else RoboHelp can benefit you. www.ehelp.com/techwr
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.