Re: Writing Corrective Actions for customers?

Subject: Re: Writing Corrective Actions for customers?
From: "Gene Kim-Eng" <techwr -at- genek -dot- com>
To: "Ned Bedinger" <doc -at- edwordsmith -dot- com>, "Michael West" <WestM -at- conwag -dot- com>
Date: Wed, 23 Apr 2008 07:45:31 -0700

This scary prospect can occur with any document; "a letter"
is no different from a manual or an online help project in that
respect. All technical writing tasks require "sensitive
knowledge and expertise" to some extent or another; the
question is whether that requirement is being recognized
and addressed and whether you or anyone else in the
company have the required knowledge and expertise.

While the basic process for creating the "a letter" are the
same "Tech Writer 101" steps as any other document
(identify requirements, line up information sources and
reviewers, write, review, edit, approve, release, etc.),
always lurking in the background is the mortifying
possibility that the necessary knowledge and expertise
to do the job right doesn't exist anywhere in your company
and you need to bring in someone who has it.

Gene Kim-Eng



----- Original Message -----
From: "Ned Bedinger" <doc -at- edwordsmith -dot- com>
> My ongoing concern is whether my work will get a thorough review and
> signoff, I think of getting that review as requiring local knowledge (at
> least acquainted with reviewers), considerable finesse, and a well-oiled
> process. Without those majoc ingrediments, reviewers will scatter when
> the subject comes up.
>
> When someone asks how to do a tech writing task requiring sensitve
> knowledge and expertise, the first question I'll have on hand from now
> on is "What's your review process like?" If expertise is modular and can
> be added on, then fantastic, write the hell out of letters or whatever
> the task is.

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

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

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.


References:
Re: Writing Corrective Actions for customers?: From: Michael West
Re: Writing Corrective Actions for customers?: From: Ned Bedinger

Previous by Author: Re: Writing Corrective Actions for customers?
Next by Author: Re: How do you manage changes to names
Previous by Thread: Re: Writing Corrective Actions for customers?
Next by Thread: RE: Writing Corrective Actions for customers Summary of Responses and DETAILED Explanation


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


Sponsored Ads