Re: techwr-l digest: June 24, 2002

Subject: Re: techwr-l digest: June 24, 2002
From: "Oren Iny" <oreniny -at- hotmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 25 Jun 2002 17:33:11 +0300


Assuming that the documentation underwent editing and a review by an MSE,
and that you (the writer) corrected what needed to be corrected, I believe
you should review the material yourself.

Remember that at this stage of the game, you've already corrected what was
needed (after editing and the MSE review) and know your material best. You
know exactly where things might have gone wrong (due to last minute changes,
perhaps) and you're the person who's going to have to correct anything
that's found incorrect/not working, not to mention the fact that I'm not
sure the QA personnel are the guys you want to count on for finding that
misplaced comma... (no offense intended).

Anyways, that's how things are run in my outfit.

I write the documentation modules I'm in charge of, the Product Manager
(who's in charge of this particular development) reviews the content and
accuracy. Next comes another TW on the team who edits the material and
ensures the content adheres to styles, conventions and the such. After that
the QA personnel go through the work flow and if necessary correct the
minute technicalities, and once all the corrections have been made, I
"publish" the documentation internally and review the entire thing from top
to bottom (in my case XML published in the company's product).

Oren Iny

Technical Documentation

enigma

Visit our Internet site at <http://www.enigma.com>



Subject: onscreen review
> From: "Elizabeth OShea" <Elizabeth -dot- OShea -at- emergesmart -dot- com>
> Date: Mon, 24 Jun 2002 15:28:52 +0100
> X-Message-Number: 16
>
> I'm soliciting opinions on who should do onscreen review of documentation
> (delivered electronically) in a company with no dedicated editing
> department. Should it be the person who wrote the documents? Should it be
> another writer who didn't write the documents? Should it be someone else I
> haven't thought of?
>
> Assume that the documents have had one grammatical/style editorial pass at
> an earlier stage, one SME pass for content validation, and this is the
> brush-up, check-the-links, find-that-glaring-comma-fault onscreen review
> before release.
>
> What does your company do in this situation?
>
> Thanks.
>
> elizabeth
>

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.

Check out RoboDemo for tutorials! It makes creating full-motion software
demonstrations and other onscreen support materials easy and intuitive.
Need RoboHelp? Save $100 on RoboHelp Office in May with our mail-in rebate.
Go to http://www.ehelp.com/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.



Previous by Author: RE: The Best TC/TW/TE Education...
Next by Author: HTML Question about Symbols
Previous by Thread: RE: real tech writers? RE: Out-of-Work Tech Writers and Switching -- Careers
Next by Thread: TOOLS: Convert HTML to PDF, maybe with HTMLDOC?


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

Sponsored Ads


Sponsored Ads