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: Documenting software From:"Wilcox, John (WWC, Contractor)" <wilcoxj -at- WDNI -dot- COM> Date:Tue, 30 Jun 1998 14:11:07 -0700
> ----------
> From: Katherin King[SMTP:kking -at- BROOKTROUT -dot- COM]
>
> For those of you who document software applications, how much of what
> you do is documenting the GUI and how much of it is documenting the
> underlying structure, the means by which the GUI is implemented? In
> other words, how important is it, do you think, for tech writers to
> understand the inner workings of the software?
>
I use the same basic criteria whether documenting software or anything
else. Audience analysis is the key. Write everything they need to
know; don't write what they don't need to know. The emphasis is on THEY
-- the audience. Determine content according to what THEY need -- not
what engineers, etc., THINK the audience needs.
Regards,
John Wilcox, Documentation Specialist
Timberlands Information Services, Application Delivery Group
Weyerhaeuser, WWC 2E2, Box 2999
Tacoma, WA 98477-2999 USA
253-924-7972 mailto:wilcoxj -at- wdni -dot- com
(I don't speak for Weyerhaeuser, and they return the favor.)
