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.
Anne Woolson wondered: <<My company is wanting to go paperless - and
send all documentation on a CD with our hardware products. We
currently ship a large printed User Guide. >>
Just to play devil's advocate here: Has anyone considered asking the
customers what they want? Personally, I get really steamed when I
spend $500 on software and all I get is a teeny little getting started
guide. Or when I have to print a massive PDF file on my laser printer.
Would it kill them to throw in a $30 copy of X for Dummies in the
package? (Are you listening, Adobe?)
<<I've been told to "just throw the .pdf file onto a disc" - but it
seems like there has to be a better way to present the digital
document. Does anyone have any ideas or suggestions? >>
First and most obviously, make the availability of the PDF obvious.
Advertise its existence everywhere, and make sure it's one of the
first two items under the Help menu.
Second, take a giant step backwards and decide what your goal is: Are
you trying to produce something that will actually be used as an
onscreen document? If so, design it to be used that way (e.g., in
landscape format), and wave your hands in the air and make lots of
loud noises about how ecologically responsible your company is. If
you're just trying to shift the printing costs to the customer,
without compensating them for this by reducing the price, then by all
means produce a printable PDF and see if you can hire Nancy Allison to
convince your customers that this is a good thing. <g>
------------------------------------------------------------------------
Geoff Hart (www.geoff-hart.com)
ghart -at- videotron -dot- ca / geoffhart -at- mac -dot- com
------------------------------------------------------------------------
Effective Onscreen Editing: http://www.geoff-hart.com/books/eoe/onscreen-book.htm
------------------------------------------------------------------------
ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals. http://www.doctohelp.com
Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-