Re: Bug tracking and documentation

Subject: Re: Bug tracking and documentation
From: That Darned Writer <j_grey -at- writeangles -dot- com>
To: Technical Writing <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 13 May 2009 11:25:29 -0700


Julie Stickler wrote:
<snip>

> development and QA have a good handle on how to use issue tracking,
> it's the folks in the field (sales engineers, support) who have the
> most valuable input (actual *customer* contact) and the most trouble
> writing good issues. I'm trying to figure out how best to coach them
> towards providing me with useful input.

Can you present to them at an SE meeting or something like that? When I
was at a larger company I used to sit in on SE training sessions and was
always able to get something in the training docs about how to report
doc issues.

When I send a doc for review, I include a single-page doc explaining
what I want them to review for and what I don't want them to review for.
If you include the SEs and support folk as part of the review, they
--in theory-- will read the review sheet.

If all else fails, I join the team for their daily lunchtime walk and
talk about it casually then. That not only makes it seem less like I'm
"lecturing" them but builds rapport, too.



_______________________________________________
joanne grey j_grey -at- writeangles -dot- com
doc goddess www.writeangles.com

Creativity comes from trust. Trust your instincts.
And never hope more than you work. - Rita Mae Brown

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals.
http://www.doctohelp.com

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
Bug tracking and documentation: From: Julie Stickler
Re: Bug tracking and documentation: From: That Darned Writer
Re: Bug tracking and documentation: From: Julie Stickler

Previous by Author: Re: Bug tracking and documentation
Next by Author: RE: Digital delivery of documentation?
Previous by Thread: Re: Bug tracking and documentation
Next by Thread: Re: Bug tracking and documentation


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

Sponsored Ads


Sponsored Ads