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'd like especially to hear from colleagues who actually feel that
>experience on a help tool is necessary to do the job.
Tim, I agree with your implication that a good technical communicator can
produce a good document, regardless of the tool that must be used to
produce it. However, I also believe that, other things being equal, a
technical communicator who has already worked with the tool will be more
efficient than one who must spend time mastering the tool in addition to
mastering the topic.
However, I think there is an issue here that is more important than the
question of with which particular tool the documentation is to be produced.
This is an understanding of how the difference between information delivery
with on-line mechanisms and print documentation changes the absorption of
the information content. We must understand how to achieve "information
transfer" in each of the various formats, based on the audience needs.
I have recently seen an article that criticizes much of the on-line help
material currently being produced because it lacks the contextual
information a user needs to orient themselves within the topic. Of course,
a good deal of criticism has also been written about print documentation
because it often leaves out the procedural material.
Before any document should be produced, the needs and objectives of the
document users must be identified and analysed to determine the proper
structure, informational content, and delivery format. Only then should the
determination be made about the document structure and whether the document
should be on-line, print, or some combination of both.
Given this, then, the question of mastery of any particular tool is moot.
chc -at- ontario -dot- com
Post Message: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
Get Commands: LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU with "help" in body.
Unsubscribe: LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU with "signoff TECHWR-L"
Listowner: ejray -at- ionet -dot- net