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.
Subject:Format for receiving document reviews From:Visnja Beg <vbeg -at- JETFORM -dot- COM> Date:Fri, 19 Jun 1998 14:39:52 -0400
Hi,
I was wondering if anyone out there in technical-writing-land has the
magic answer to what is the best way to receive comments from
developers/engineers on the documents you write.
Specific questions I would like answered are:
* Is there a good method for an online review. For example, for
help files, we don't want anyone mucking around with our .RTF files -
what are other options for adding comments to help panels?
* How about an online review of FrameMaker documents - is there a
tool that we can use to put "post-it" type notes on the document pages
but that are easy to delete from the document afterwards?
* Do any of you use the method of printing out documents and
asking the reviewer to write their comments directly on the paper?
* How have you dealt with the "unresponsive" reviewer?
* How do you ensure that you do receive comments back from the
reviewer in a timely manner?
* Do you have any examples good and bad experiences with reviews
of your documentation? Please share!
Thank you for any information and help you can give me.
Sincerely,
Visnja Beg
=============================================================
Visnja Beg Phone:
(613) 751-4800 ext.5705
User Education Fax:
(613) 751-4864
JetForm Corporation mailto:vbeg -at- jetform -dot- com
=============================================================