RE: Honestly -- when an SME completely REWRITES your text ... GEEZ!

Subject: RE: Honestly -- when an SME completely REWRITES your text ... GEEZ!
From: "Sarah Blake" <Sarah -dot- Blake -at- microfocus -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 22 Oct 2008 10:43:25 +0100

> I have had such comments from SMEs such as "This is wrong!" (without
> saying what is right) and the ever-helpful "WTF!".

I've occasionally had comments such as "This is wrong!" when it wasn't.
Turned out that communication had been less than clear between the lead
developer (who was reviewing the doc) and the person actually
implementing the feature.

On one occasion, my accurate documentation of a feature that none of the
developers could remember coding led to semi-serious accusations that
I'd coded it myself...

As a result, there are two things I bear in mind when dealing with SME
reviews of the documentation.

1. The SME is not always right.
2. When making an SME-requested change to a doc, always keep some record
of which SME gave you the new information. Not just to cover yourself,
but to uncover any fundamental misconceptions within the team.

Sarah Blake
Senior Technical Author
Micro Focus

Please consider the environment before printing this e-mail.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

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-

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:
RE: Honestly -- when an SME completely REWRITES your text ... GEEZ!: From: Doug Cuff
Re: Honestly -- when an SME completely REWRITES your text ... GEEZ!: From: Janice Gelb
RE: Honestly -- when an SME completely REWRITES your text ... GEEZ!: From: Ron Hearn

Previous by Author: File conversion services - UK
Next by Author: Re: TECHWR-L Digest, Vol 36, Issue 24
Previous by Thread: Re: Honestly -- when an SME completely REWRITES your text ... GEEZ!
Next by Thread: RE: Honestly -- when an SME completely REWRITES your text ... GEEZ!


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


Sponsored Ads