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:Scott Miller <smiller -at- CORP -dot- PORTAL -dot- COM> Date:Tue, 30 Jun 1998 13:00:00 -0700
We don't document the GUI, or how it's implemented. We document how to
get your work done. The GUI, as often as not, gets in the way of getting
your work done, so it's not something we want to focus on.
- Scott Miller
smiller -at- portal -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?
>