Re: Peer Review Process/Best Practices?

Subject: Re: Peer Review Process/Best Practices?
From: "Raj Machhan" <raj -dot- machhan -at- gmail -dot- com>
To: "Geoff Hart" <ghart -at- videotron -dot- ca>
Date: Wed, 27 Feb 2008 10:14:23 +0530

For a end user document, a peer review would essentially involve getting
your fellow writers to use the application as per the steps given in the
document. Take care to select only those writers who have never worked on
the application before.

Raj

On Wed, Feb 27, 2008 at 4:09 AM, Geoff Hart <ghart -at- videotron -dot- ca> wrote:

> Jill Mohan wondered: <<Is there anybody out there using a slightly
> formalized process for getting documents reviewed prior to delivery?
> If you are, can you share some best practices?>>
>
> Not since I went freelance, but beforehand we had a rigorous review
> process and it worked really well. There are many related articles on
> my Web site (http://www.geoff-hart.com/resources/bibliography.html)
> based on real-world experience, particularly those related to getting
> reviewers to do a good review, but a good place to start would be
> "Designing an effective review process" (http://www.geoff-hart.com/
> resources/2005/reviews.htm).
>
> If you'll be attending WritersUA in a couple weeks, stop in at my
> presentations, one with Char James-Tanny on editing help systems
> (http://www.writersua.com/ohc/track5.htm#session40) and another by
> myself on workflow re-engineering (http://www.writersua.com/ohc/
> track5.htm#session47). The latter presentation is particularly
> relevant, and I'm hoping to write it up formally for STC or another
> venue at some point.
>
>
> ----------------------------------------------------
> -- Geoff Hart
> ghart -at- videotron -dot- ca / geoffhart -at- mac -dot- com
> www.geoff-hart.com
> --------------------------------------------------
> ***Now available*** _Effective onscreen editing_
> (http://www.geoff-hart.com/home/onscreen-book.htm)
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> 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 raj -dot- machhan -at- gmail -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/raj.machhan%40gmail.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.
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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:
Peer Review Process/Best Practices: From: Jill Mohan
Peer Review Process/Best Practices?: From: Geoff Hart

Previous by Author: Re: Beginning Titles with "How To"
Next by Author: RE: TECHWR-L Digest, Vol 28, Issue 23
Previous by Thread: Peer Review Process/Best Practices?
Next by Thread: Re: Peer Review Process/Best Practices


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


Sponsored Ads