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: what are the best books in our field? From:Richard Mateosian <srm -at- CYBERPASS -dot- NET> Date:Sat, 18 Apr 1998 13:55:04 -0700
>BY FAR the best book that I have read in the area of technical
>communication is STRUCTURED SYSTEMS ANALYSIS AND SPECIFICATION
>by Tom DeMarco (Yourdon Press, 1979).
Yes, it's a good book, but it overlaps what we normally call
technical communication mainly in the area of task analysis.
It does not give you insight into the target audience's background
and learning styles.
It offers no help in separating the entities, relationships, and flows
that are important for the user to understand from those that are
important to the programmer but invisible to the user (assuming that
your audience is the user).
It doesn't give you much insight into which tasks users are most
likely to want help with or how they are likely to look for that
help.
It offers no help with the mechanics of presenting task-oriented,
usable information in the media of choice.
It offers only peripheral help in planning, scheduling, and tracking
the progress of the documentation sub-project.
While you could apply the techniques of the book to the documentation
task as a system, I don't believe anyone has developed a writing process
based on that kind of analysis. Perhaps this will happen as tightly
integrated online help becomes the norm rather than the exception. ...RM
Richard Mateosian <srm -at- cyberpass -dot- net>
Review Editor, IEEE Micro Berkeley, CA