Re: Footnotes - acceptable in technical documentation?

Subject: Re: Footnotes - acceptable in technical documentation?
From: Robert Lauriston <robert -at- lauriston -dot- com>
To: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 8 Nov 2013 08:38:36 -0800

I occasionally use table footnotes to avoid having to put too much
text in a cell.

Otherwise, no. The information is relevant or it's not, even in
conceptual and reference material.

Plus, where do you put footnotes in HTML output? You could make them
pop-ups but I think that sort of modal thing is bad design.

On Fri, Nov 8, 2013 at 8:33 AM, Bruce Megan (ST-CO/MKP3)
<Megan -dot- Bruce -at- us -dot- bosch -dot- com> wrote:
> 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.


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


Follow-Ups:

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: Footnotes - acceptable in technical documentation?
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