Re: Tech Documentation info to Developers and QA

["Karen E. Black" <kblack_text -at- hotmail -dot- com>]

Pooja, your manager and the QA manager (in my job, also as solo writer, 
they're the same person: tech writing is under QA) should be backing you up 
in requiring that the user documentation (which really is part of the 
interface) be subject to quality assurance as well as the software. The tech 
writer also has a role to play in the usability/design of the site. 
Usability is a requirement for software as well. Can you get on the 
reviewers' list for the functional design/software requirements 
specifications?

As for making changes to the GUI, if the tech writer is part of the design 
team, it's easier to have influence early in the project, rather than trying 
to get changes made after testing has begun. QA doesn't want to send the 
software back to development for changes at this point. If you have 
suggestions about design/usability, document your suggestions and send them 
to the QA team leader, and copy the QA manager, YOUR manager, and the 
development team leader.

Also, get a friendly cow-orker (different from a co-worker ;-) ) to review 
your approach to the development and QA people. If you come across as 
condescending or abrupt, or if you don't properly rationalize your changes, 
you may need to re-cast your suggestions more objectively.

In my company, "QA" has traditionally started after the development team has 
finished coding and implemented the software to the QA environment. We are 
currently writing policies about the responsibility of the whole IT group in 
maintaining QA standards, which means that the business analysts must 
include QA standards when they write the project charter, before 
requirements gathering and system design have begun. I also have to remind 
people (after 2 years) what my role is on the team and in the project 
process. It gets tiring.

Prince John might say to develop a relationship with Dev and QA people by 
talking to them socially; maybe ask them to join you for lunch? This might 
make them more open to your input than if you just talk business all the 
time.

Best of luck. You're doing the right things, but maybe at the wrong time and 
place.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Is fearr socrú dá dhonacht ná dlí dá fheabhas.
It's better to solve the problem than to improve the law.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

"Pooja Malhotra" <pooja -dot- malhotra -at- induslogic -dot- com> writes: