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: [twin] Query: ways to gather info about usage of documentation
Subject:Re: [twin] Query: ways to gather info about usage of documentation From:Sandy Harris <sandyinchina -at- gmail -dot- com> To:TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Sat, 19 Mar 2011 12:53:37 +0800
Also consider what other sources might give you useful feedback.
If you provide tech support, ask questions of the support people.
What parts of the docs do they use most often? Or often refer
users to? Are there undocumented things they tell users?
Things users regularly mis-understand? Things that might be
better indexed -- the info is there at X but users don't find it;
they ask about Y?
Is there a user or support mailing list for your product? Do
your writers read it? What about lists on related topics?
I'd say the Word developers and documenters could learn
things on this list, for example.
Is there a FAQ document for common user questions?
Should there be? Often, yes.
You do have to be prepared to shoot anyone who tries
to turn the FAQ into a marketing presentation.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days. http://www.doctohelp.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-