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: Great Technical Manuals from Canon! From:Amy Gale <amyg -at- grammatech -dot- com> To:TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 23 Aug 2007 16:27:12 -0400
I recently(ish) bought a Canon digital camera. I had a couple of
thoughts about the documentation.
GOOD:
1) English and Spanish manuals were in separate books. I was able to put
the ones I didn't need into the recycling bin as soon as I opened the box.
2) Manual (for each language) divided into two small books. I don't have
them with me at work, but the gist is something like "simple stuff you
need to get started" (thin) and "more complicated stuff you may care
about eventually" (thicker).
BAD:
1) Too much manual switching. YMMV, but once I've been sent to the "more
complicated stuff" manual, I don't want to have to refer back to the
"simple stuff" manual. One switch is enough. This may mean a little bit
of redundancy. So be it.
Biggest problem of all is, of course, remembering to use it. I'm still
far more inclined to run into the house and holler "come out and see
this awesome butterfly!" than to think "ooo, I must get a photo of that
butterfly".
Amy "actual example" Gale
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
