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.
That is it. That is the big mystery behind technical writing. There is no
standard font or page size. There is no global standard for a user's guide
or reference manual. There are no standards for what goes into a help file
vs. the paper manual.
Yes, some companies do set up standards in the form of style guides,
hopefully based on the accumulated knowledge of working with a particular
audience. But the standards that Fartenblower Software, Inc. follows will
probably not be the same as the ones followed by the writers at Geekzoid
Computer Hardware, LLC. Other organizations, such as the military, impose
standards. Again, these are not global standards.
This ain't no paint-by-the-numbers, fill-in-the-blanks job. If it were, any
schmuck with the proper outline, template, and acceptable word list could do
it.
THAT is why we get paid the big US$1.50 (after taxes). Not to poop out
cookie-cutter documents that adhere to someone's vision of what a user's
guide should be, but to craft information solutions based on the audience,
product, use, and a thousand other variables.
Thank you. I may now be excommunicated from the siblinghood of technical
communicators for exposing this dark secret.