TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Re: Anyone have a boiler plate Reviewer Comments sheet?
Subject:Re: Anyone have a boiler plate Reviewer Comments sheet? From:Ned Bedinger <doc -at- edwordsmith -dot- com> To:Susan Herrin <susan -dot- herrin -dot- us -at- gmail -dot- com> Date:Fri, 15 Feb 2008 14:06:47 -0800
I think you want to avoid sounding detached or patronizing. If you know
your users, you shouldn't have any trouble being very specific about
what sort of comments you're inviting, because you know how they use the
documentation and what sort of issues they might have with it.
But anyway, the last time I did this, I think I settled on something
general like this:
=======================================================================
Please submit official comments about this document to <emailaddress>.
All official comments are logged and evaluated before the next document
update.
Your unofficial comments and questions are also welcomed. Email or
voice message your contact information if you'd like a call back from
the Technical Writing staff responsible for this document.
Susan Herrin wrote:
> Sorry, I guess wasn't clear about this.... What I meant was a blurb to
> publish in the documentation for *customers *to see... something like
> this..... Thanks in advance! Susan
>
> We care about your experience!
>
> If you have any complaints or suggestions about this publication,
>
> please email your comments to techpubs -at- company -dot- com <techpubs -at- litle -dot- com>.
>
> Thank you!
>
>
> On Thu, Feb 14, 2008 at 4:26 PM, Susan Herrin <susan -dot- herrin -dot- us -at- gmail -dot- com>
> wrote:
>
>> Hi all,
>>
>> I'm adding a new page to our doc that explains how to submit feedback on
>> our documentation. Does anyone have boiler plate text that you can share?
>>
>> Thanks!
>> Susan
>>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> 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 doc -at- edwordsmith -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/doc%40edwordsmith.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-