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:FWD: Meatball Tech Writing From:Anonymous User <anonfwd -at- RAYCOMM -dot- COM> Date:Wed, 17 Feb 1999 10:54:46 -0700
Name withheld upon request. Please reply on list.
*************************************************
One of the characters in the M*A*S*H TV show once referred to the
surgery performed at the MASH hospital as meatball surgery. Get it done
and get on with the next thing.
Most of the places I have practiced my trade, that's the best
description of the technical writing I've been able to do. I cut corners
and raise the bar as much as I can, but in the end, I have deadlines and
constraints that are outside my control. My current job is the most
exteme case of this, as development and release cycles are often three
weeks or shorter. The documentation I inherited is substandard in lots
of ways and because of our aggressive schedule and lack of process,
there's really no way I can do what needs to be done to bring the doc up
to spec. I'm trying, but progress is happening at a glacier-like pace.
As far as things like user analysis, hitting the least common
denominator, site visits, and all the other things that real tech
writers do, they just aren't possible. Perfection, or anything remotely
close to it, is not an option.
Or so I submit. I guess my question is this: in cases like mine, do you
perceive that the responsibility to the user and to the profession is so
great that the writer has an obligation to do whatever it takes to go
after perfection? Is pragmatism in this situation a copout or a
legitimate survival technique? Is pointing at management merely
excuse-making?
And, what, if anything, seems to be a magic pill to change it (other
than the obvious work hard and pick your battles and try for incremental
improvement--which I do)?