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.
I think Canon is still searching for the best way to do manuals.
I have a Canon digital camera now, and I owned an earlier model
previously. These cameras came with one big manual that described
everything in detail, but didn't tell you "what to do." I had to read
the entire manual to get an idea of how to start out.
Based on my study of technical manuals and on some articles I have read,
I believe that the detailed, all-in-one approach to manuals is based in
some Asian cultural attitudes towards learning and writing. The early
Canon manuals seem to be a direct translation of the original Japanese
manual.
>From Jessica's description, I guess that Canon has concluded that their
American customers get confused by the all-in-one approach. They have
now moved to a Getting Started guide and a reference manual. This
approach is quite common in computer software; I am doing something like
this right now myself.
When I write for developers, I do put in a Getting Started/Architecture
guide. I also write up all the procedures, and provide a reference
guide. Very often, the reference guide is in the form of
context-sensitive help. I don't repeat much information, but then again
my documentation is basically electronic.
In a print world, the best idea would be to summarize the basics in the
reference/procedures guide as well. So you would have
* Getting started: hardware setup, software installation, intro to
photography, basic picture
taking
* Procedures: detailed steps for setting everything up
* Reference: specs, features, glossary, index
Not all manuals are perfect. I applaud Canon for at least getting to the
point they're at now. Modern digital cameras offer an incredible set of
features, many more than the most sophisticated film camera I ever
owned. Ironically, digital cameras have nearly wiped out the demand for
film cameras, *including* the simple, no-options disposable cameras that
people used to rely on. You now have the mass market of snapshot-takers
trying to work with cameras that are more complicated than those a pro
photographer used thirty years ago!
Joe
Joe Malin
Technical Writer
(408)625-1623
jmalin -at- tuvox -dot- com
www.tuvox.com
The views expressed in this document are those of the sender, and do not
necessarily reflect those of TuVox, Inc.
-----Original Message-----
From: techwr-l-bounces+jmalin=tuvox -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+jmalin=tuvox -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf
Of Jessica Weissman
Sent: Tuesday, September 05, 2006 5:55 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: canon camera user doc style
I bought a new Canon camera over the weekend. The camera is a complex
marvel that lets me take better pictures than my old camera did, but
that's not what we're interested here.
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l
Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-
