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: Educating Rita From:"Peter J. Harbeson" <harbeson -at- GARLIC -dot- COM> Date:Sat, 1 May 1999 22:23:49 -0700
> My question: What's an effective way to approach
> a touchy, rather defensive SME to offer help in
> designing a GUI?
On the projects I work on, this would be done by submitting a bug report
that clearly lays out the usability problem, the impact on the user, the
workaround (if any), and the proposed fix. Writing clear, useful bug reports
is a valuable technical writing skill.
>Technical writing is information delivery, or as I like to say, "ramming as
>much information down the user's throat as painlessly as possibly."
Yeah, I've seen documentation created from that perspective. It's useful for
my "examples of what to do wrong" file. I think it's important to take into
account the audience, the problem the user is trying to solve in turning to
the documentation, and how to make the right information easily available at
the right time and place.
Software interfaces ARE information delivery; that's why technical writers
need to care about them, and why the perspective of a technical writer is
valuable in interface design.
Peter J. Harbeson ( harbeson -at- structions -dot- com )
Technical Writing, Instructional Design, Help System Engineering