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 wanted to drop a quick note to the list to say "Thank you!" for all
the help that I received on my recent question about what enterprise
software companies do for their documentation help.
The summary of what I heard from everyone was:
1. *Give the users what they want. *Find out what the users want and
need and give that to them. Don't use a cookie cutter approach (loved
that expression for this), but ask the users in depth what they feel
they need to get more mileage out of the software.
2. *Consider having the documentation & help available publicly.* Unless
there's something proprietary, act like you're proud of your
documentation and software. (And if you're not, you should fix that!)
FWIW, this is the same methodology espoused in “Inbound Marketing,”
where the authors publish the business plan for their successful Silicon
Valley company on their website. It lets potential customers know where
they’re going and if any competitor wants to try and copy it, sure;
they’re going to be several years behind in their efforts. The same
thing is true of us and what we’re showing in the documentation.
There were a number of helpful references for add'l further research,
such as to itbusinessedge.com, salesforce.com, and "Developing Quality
Technical Information, 3rd ed."
All of these comments were very helpful, and I thank you, one and all.
--
Yours truly,
John Hedtke
Consultant/Author/Contract Writer
Fellow, Society for Technical Communication
541-685-5000 (office landline 9-9 Pacific)
541-554-2189 (cell)
john -at- hedtke -dot- com
LinkedIn: http://www.linkedin.com/in/johnhedtke
Twitter: JohnHedtke
Blog for writers and authors: http://tradebookauthor.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Learn more about Adobe Technical Communication Suite (2015 Release) | http://bit.ly/1FR7zNW
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com