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.
RE: Tech documentation info to developers and QA? - Thanks all
Subject:RE: Tech documentation info to developers and QA? - Thanks all From:"Pooja Malhotra" <pooja -dot- malhotra -at- induslogic -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 17 Mar 2003 15:42:36 +0530
I want to thank everyone on this list for their valuable suggestions.
Conclusion I could draw from all the mails was to earn respect from the
developers first and if it comes to pointing out changes in their GUI,
it must be very subtle. Though, I had taken the same approach but I
guess, I have been wrong somewhere.
Probably, with time, I shall gain the respect and make a place for
myself in the organization.
Thanks once again,
Pooja
P.S. BTW, my presentation, following Brijesh's concept of taking the
negative approach first and then leading to positive was a success.
Brijesh wrote...
<<why dont u start by giving examples of what bad documentation can do ?
what is bad UI ?
how a good UI can make big difference to the users...
i guess examples is where you shud start your presentation. they will
understand it better.
- if you have time, just take one bad screen, change it ( image only)
and show them, the diff.
- documentation process is an important thing, but I guess u should
reserve that to a later stage, when your audience start understanding
the importance of good documentation.
- pick bad emails that were written, tell them the mistakes....
remember do no point fingers!...>>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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: http://www.ehelp.com/techwr-l
Help celebrate TECHWR-L's 10th Anniversary starting this month!
Check out the contests at http://www.raycomm.com/techwhirl/special/contests/
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 http://www.raycomm.com/techwhirl/ for more resources and info.