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.
RE: Feedback requested: What doc format do your customers require?
Subject:RE: Feedback requested: What doc format do your customers require? From:"sbuckley" <sbuckley -at- onlinewriter -dot- com> To:"'Shawn'" <shawnly9 -at- yahoo -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 26 Apr 2007 08:55:04 -0700
The best way to find this out is to survey your users. The main problem
with surveys is wording the questions correctly, so that they aren't
leading. And then to take part in actual user visits to be able to double
check any surprising results.
For example, one of the first times I got end-user help questions on a
marketing survey, I was only allowed a limited number of questions. So I
thought it would be efficient to have check boxes and have users select all
the formats they wanted (printed manual, online, web, and etc.). Printed
manual came out the winner.
That year at a conference I saw a talk that included ideas for the size of
the manual so your users would keep it around. So in my next user visits I
asked people where they keep their manuals to get an idea of the size we
should consider. None of the participants had looked at the
manual...ever...even when they opened the box the product came in.
On the next survey (plus a few survey classes and survey subject books
later) I asked more along the lines of "the last time you needed information
where did you go?" The answer: the Web. The reason: users wanted
information that moved with them and didn't know online help existed.
If you can't find a survey class (check marketing courses) a great book is
How to Conduct Surveys by Arlene Fink. It's a good book to check out even
if you do find a class. I'm presently rereading it because the third
edition is out. You can find it at libraries.
That aside the best help that follows users and limits the need for any
documentation is good design and embedded help. The next best step is the
person next to them, who are usually gurus who read help.
-----Original Message-----
From: techwr-l-bounces+sbuckley=onlinewriter -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+sbuckley=onlinewriter -dot- com -at- lists -dot- techwr-l -dot- com] On
Behalf Of Shawn
Sent: Wednesday, April 25, 2007 11:47 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Feedback requested: What doc format do your customers require?
Hi all,
I'm in the process of revamping documentation for my company and need some
input.
Do your end-users still require documentation in PDF (regardless of whether
they actually read it or not!)? My feel is that they will require
a PDF as a security blanket, but then want the "nicety" of other
tools....online help, flash demos, HTML documentation, etc.
I'd really like to hear your thoughts and experiences. Also, if
anyone knows of a survey that includes this sort of information, please
send it my way.
Thanks,
Shawn
__________________________________________________
Do You Yahoo!?
Tired of spam? Yahoo! Mail has the best spam protection around http://mail.yahoo.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as sbuckley -at- onlinewriter -dot- com -dot-
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
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-