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.
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?
Tony Markatos responds:
Software documentors (i.e. creators of end user manuals and training
manauls) specify procedure. And effective organization of procedure is
based upon a clear and concise understanding of WHAT the software does
from an end user perspective. No knowledge of HOW the software is
implemented is necessary to do such.
Tony Markatos
______________________________________________________
Get Your Private, Free Email at http://www.hotmail.com
