RE: Footnotes - acceptable in technical documentation?

Subject: RE: Footnotes - acceptable in technical documentation?
From: Dan Goldstein <DGoldstein -at- cytomedix -dot- com>
To: "TECHWR-L (techwr-l -at- lists -dot- techwr-l -dot- com)" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 8 Nov 2013 11:46:33 -0500

A lot of technical documentation has nothing to do with instructions (for example, engineering specifications). I've used footnotes when it seemed right for the audience. But if your company doesn't want footnotes, they should specify that in the style guide.


-----Original Message-----
From: Bruce Megan
Sent: Friday, November 08, 2013 11:33 AM
To: TECHWR-L
Subject: Footnotes - acceptable in technical documentation?

Hello All:

What are you thoughts on footnotes in technical documentation? I have been told that footnotes in technical documentation is forbidden because instructions show the reader how to do something, and footnotes distract the reader from instruction.

Your thoughts?

Megan



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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:
Footnotes - acceptable in technical documentation?: From: Bruce Megan (ST-CO/MKP3)

Previous by Author: RE: So now we are content engineers?
Next by Author: RE: So now we are content engineers?
Previous by Thread: RE: Footnotes - acceptable in technical documentation?
Next by Thread: Re: Footnotes - acceptable in technical documentation?


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

Sponsored Ads


Sponsored Ads