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: Technical Writing and Time From:Richard Mateosian <srm -at- CYBERPASS -dot- NET> Date:Thu, 13 Aug 1998 14:31:36 -0700
>Today people are far more expensive than computer time. The time
>code takes to run is not as important as the time it takes the
>programmer to write it.
>The same can be said of us technical writers. The manuals I write
>need to be complete but terse because it is the customer's time
>that is important.
If you apply the logic of the second paragraph to the first one, you'll
conclude that the programmer should spend the extra time to make an
efficient program that saves a little time for each of possibly
millions of users.
Unfortunately, most firms reason as you did in the first paragraph.
They save a little development expense, because they know their
customers have no real alternative to putting up with bloated,
inefficient programs.
Even more unfortunately, many firms do not reason as you did in the
second paragraph. They provide as little helpful documentation as they
can get away with. If they put out "terse" manuals, it's rarely to save
time for their customers.
Companies that put out truly useful minimalist manuals find that these
cost about as much to produce as the screenshot-padded useless fat
ones. ...RM
Richard Mateosian <srm -at- cyberpass -dot- net> www.cyberpass.net/~srm/
Review Editor, IEEE Micro Berkeley, CA