Re: Tech Documentation info to Developers and QA

Subject: Re: Tech Documentation info to Developers and QA
From: Andrew Plato <gilliankitty -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Sat, 15 Mar 2003 10:18:52 -0800 (PST)

"Pooja Malhotra" wrote...

> I have been asked to give a presentation to the QA team, where in I can
> explain them the fundamentals and keys tips to test a document against
> the software. I have some knowledge as per my experience and exposure to
> technical writing but still would appreciate if you could provide me
> some more tips.

Don't waste time with QA. QA groups typically have very little authority, as
such they are often petty tyrants. You should be bumping your edits back to the
programmers/developers and ignore QA.

Also, never assume that it is your job to design the UI. A lot of writers like
to just assume they have this right - they don't. Your best bet is to start
small and make a few suggestions and then slowly earn the respect of the
developers. Writers are not UI designers by default.

If you show up demanding a lot of changes without the authoritity, then its not
unusual that you'll get the cold shoulder. Earn their respect FIRST.

Andrew Plato

Do you Yahoo!?
Yahoo! Web Hosting - establish your business online

Order RoboHelp X3 and receive a $100 mail-in rebate, plus FREE
RoboScreenCapture, WebHelp Merge Module and iMarkupSoftware, for a total
giveaway value of $473! Order here:

Help celebrate TECHWR-L's 10th Anniversary starting this month!
Check out the contests at
Happy birthday to you, happy birthday to you, happy birthday TECHWR-L....

You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit for more resources and info.

Previous by Author: Generalism vs. Relativity
Next by Author: Re: Hearing (or seeing) what isn't there
Previous by Thread: Re: Tech Documentation info to Developers and QA
Next by Thread: Re: Tech Documentation info to Developers and QA

What this post helpful? Share it with friends and colleagues:

Sponsored Ads