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.
> A few questions:
> How often do SMEs give you their write-up of a manual, or at least
> information, before you start on your work? Would you say that this
> common thing to happen?
It's only happened to me once -- though it wasn't a whole manual, just
an installation procedure. Like your SME, he didn't want anything
Fixed the typos. Wanted to verify the procedure with the technicians
that actually did the procedure -- to see if they found any problems
with the procedure, or, better yet, if they found any shortcuts, etc.
Alas, the SME wasn't pleased ("Oh, yeah; I meant to warn you about
that guy," said my mentor), and the lead tech I needed to interview
was gone for the day, so the manual went out with his installation
procedure as he wrote it -- minus the typos.
> If you do have experience with SMEs giving you their information in
> they think is a manual (or other output) format, how much liberty do
> to change it into readable and digestible information (what we all
> to do as technical writers)?
"Dammit, Jim, I'm an engineer, not a tech writer!"
If you could only get your SME to say that as a mantra ....
> This goes back to an earlier post about the engineer here infecting
> with his propaganda. I ask the questions above because I'm catching
a lot of
> flack now from him for formatting his information (with much
addition of my
> own research) into a user manual, different from the way he
> it He didn't want anything changed.
Ordinarily, I'd recommend putting all the blame on "The Style Guide."
But, if I remember your situation correctly, you're a Lone Techwriter,
new in the position, and there is no style guide.
If that's the case, perhaps throwing one together would help.
Even better, since the engineer thinks he's a writer, get his help in
putting it together. If you bother him enough about serial commas,
headers, etc., etc., he'll probably run screaming for the hills! :o)
"Ladies and gentlemen, in the event of a sudden loss of pressure
inside the cabin, an air mask will drop down. Unfortunately, the
little plastic bag will not fill up with life giving oxygen until you
pay each of us five bucks. Enjoy your flight."
--Another Recently Unemployed Flight Attendant