RE: Question about "sidebars"

Subject: RE: Question about "sidebars"
From: "Lippincott, Richard" <RLippincott -at- as-e -dot- com>
To: "Cardimon, Craig" <ccardimon -at- M-S-G -dot- com>, "'techwr-l -at- lists -dot- techwr-l -dot- com'" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 9 Oct 2013 18:49:46 +0000

We put the material in a paragraph format called "Note." (We're in FrameMaker, but the concept is the same no matter what the system, only the mechanics differ.)

Up in the manuals front matter (it actually appears in our safety section) we define a Note as a paragraph "intended to convey pertinent information about a task. It is not a procedural step." We place then either before or after the relevant paragraph in the procedure, depending on what makes the most sense.

For what it's worth, that definition is also a close match for the standard definition of a Note found in aviation and MIL-STD manuals.




Rick Lippincott, Technical Writer
American Science and Engineering, Inc. | www.as-e.com  
829 Middlesex Turnpike | Billerica, MA 01821 USA | Fax +1-978-262-8702
Office +1-978-262-8807 | rlippincott -at- as-e -dot- com






-----Original Message-----
From: techwr-l-bounces+rlippincott=as-e -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+rlippincott=as-e -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Cardimon, Craig
Sent: Wednesday, October 09, 2013 11:54 AM
To: 'techwr-l -at- lists -dot- techwr-l -dot- com'
Subject: Question about "sidebars"

Morning, Whirlers,

How do you folks handle sidebar notes and info?

Let's say I'm working on Topic A in a user guide. I have information related to Topic A, but not directly.

This information doesn't really fit elsewhere, so it needs to be in Topic A, but stand out just a bit. I put this "sidebar" information in a table in Topic A.

Users should be aware of this information but not get hung up on it. I labeled the table as a "Note." Not sure what else to do here. Suggestions?



Cordially,
Craig Cardimon

Information contained in this e-mail transmission is privileged and confidential. If you are not the intended recipient of this email, do not read, distribute or reproduce this transmission (including any attachments). If you have received this e-mail in error, please immediately notify the sender by telephone or email reply.


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.

Learn more: http://bit.ly/ZeOZeQ

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

You are currently subscribed to TECHWR-L as rlippincott -at- as-e -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.

Learn more: http://bit.ly/ZeOZeQ

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

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-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


References:
Question about "sidebars": From: Cardimon, Craig

Previous by Author: Re: Excellent post by Mark Baker regarding content jobs
Next by Author: Agile Environment Opinions Wanted
Previous by Thread: Re: Question about "sidebars"
Next by Thread: Re: Question about "sidebars"


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

Sponsored Ads


Sponsored Ads