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.
Subject:Re: Need Troubleshooting advice From:Dave Meek <meekd -at- WSERVER -dot- DO -dot- LOSRIOS -dot- CC -dot- CA -dot- US> Date:Fri, 23 May 1997 12:32:18 -0700
At 12:43 PM 5/23/97 -0500, Stephen P. Victor wrote:
>Working with support people (very important) and developers, a technical
>writer can produce guides that address real problems experienced by real
>users. You're correct that there could be an infinite variety of
>software/hardware configurations, but don't most software developers
>have a limited set of *supported* configurations? Working within the
>limits of supported configurations, it's possible to write
>troubleshooting guides that are both complete and useful.
In my experience, working with support people is *the* most important
consideration of my job. All day long, support people depend on the
documentation I create, and they walk customers through those same pages as
well. Documentation that works for support people tends to work for
customers too. And customers, after hearing support people tell them, "The
information you need is on page such-and-such," gain confidence in the
document and begin to utilize it more.
A good working relationship with your support staff is a highly valuable
resource for improving your technical writing and for supporting decisions
you make regarding the structure and presentation of your documents.