RE: Notes, tips, and warnings... oh my!

["Denise L. Moss-Fritch" <denise -dot- fritch -at- os -dot- varian -dot- com>]

-----Original Message-----

> Here is my question: Do notes, tips, and warnings really help the user
find
> the information he/she needs? Or, do they just break up the flow of
> information and make it harder to understand the task being described?

*********************************************************************

I suppose there is no "cast in concrete" answer for _all_ tech writing in
answer to your question. The response will depend upon the industry.

I currently work in a highly regulated (meaning FDA and foreign equivalents)
industry. All our publication are reviewed by our company's internal
Regulatory Department before release. The content of Notes, Cautions, and
Warnings are carefully read.

Denise L. Moss-Fritch
Sr. Tech Writer
Varian Medical Systems
Palo Alto, CA



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

Collect Royalties, Not Rejection Letters! Tell us your rejection story when you 
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of 
your book. What are you waiting for? http://www.iuniverse.com/media/techwr

  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.

---
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.