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: Word to the wise From:"Bill Swallow" <techcommdood -at- gmail -dot- com> To:"Pro TechWriter" <pro -dot- techwriter -at- gmail -dot- com> Date:Tue, 26 Feb 2008 15:09:25 -0500
I always accept everything people give me and thank them, and always
explain why I need more if what they gave me is insufficient (I never
couch it that way with them, though).
I had the same exact battle you fought, though it was over giving
writers direct write access to the product source code. You can
imagine the opposition it was initially met with. But, by detailing
how we would work, and showing them that we'd follow their exact
process for check-ins and quality control. It also helped to show them
a flow diagram of the two workflows (the desired was 1/3 as complex)
and also showed the # of hours spent the old way vs. the # hours it
would have cut from that process. We got the access, and we made good
on not breaking the code.
Well, I actually broke the build once, doing something completely
unrelated. But that happens with Devs a lot too. My punishment? I was
awarded "The Fish", a trophy of a singing trout dressed like Elvis. It
floats around from person to person as boneheadded mistakes are made.
It was actually quite an honor winning the fish. :)
On Tue, Feb 26, 2008 at 2:57 PM, Pro TechWriter
<pro -dot- techwriter -at- gmail -dot- com> wrote:
> Mr. Developer: "It's too much of a risk to give you access to the app. Just
> document the screen shots."
>
> Tech Writer: "I'm sorry, I can't validate what I write, so I can't be sure
> of the accuracy of the documentation. I need access to the app, if nothing
> more than to look at the windows, so I can document the app. "
--
Bill Swallow
HATT List Owner
WWP-Users List Owner
Senior Member STC, TechValley Chapter
STC Single-Sourcing SIG Manager http://techcommdood.blogspot.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-