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.
Sierra Godfrey <<...was perusing a book on marketing principles... For several
chapters, the book goes on about "getting to the point"... The book says, "...
Most marketing communications fail for the same reason. They never tell you
what their point is. Tell people in a single compelling sentence why they
should buy from you instead of someone else." For you minimalist tech writers,
do you think this at all applies to how we write technical information?>>
Unquestionably. People read documentation to accomplish something, not to wade
through lengthy introductions in the hope that they've found the right section
of the book. There's also no question that many forms of instruction do still
require an introduction to provide context for certain audiences. This context
may be something as simple as "don't try this unless you've made a backup" or
something as complex as an explanation of the metaphor used for the user
interface and underlying data architecture. So the techwhirler equivalent to "a
single compelling sentence" is something that reassures the reader that they've
reached the right part of the docs, and provides any crucial information they
need before proceeding.
> The book also goes on to say how oranges are actually green and growers spray
> them with some compound to make them orange (in an attempt to show how we all
> buy into fake things), but I doubt this because the organic oranges I buy are
> orange, and I've never seen a green orange on a tree.
I've heard the same thing. Although it's true that _ripe_ oranges are indeed
orange, many commercial fruits are picked long before they're ripe and are
ripened artificially during storage or transport; the goal is to ensure they'll
survive storage and transport from (say) southernmost Florida to northernmost
Ontario and arrive ready to eat. Organic produce is usually sold to a smaller
audience more concerned with quality, and is thus likely delivered ripe--and
--Geoff Hart ghart -at- netcom -dot- ca
Pointe-Claire, Quebec, Canada
"Most business books are written by consultants and professors who haven't
spent much time in a cubicle. That's like writing a firsthand account of the
Donner party based on the fact that you've eaten beef jerky."--Scott Adams, The