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.
RE: Footnotes - acceptable in technical documentation?
Subject:RE: Footnotes - acceptable in technical documentation? From:"Cardimon, Craig" <ccardimon -at- M-S-G -dot- com> To:"'Bruce Megan (ST-CO/MKP3)'" <Megan -dot- Bruce -at- us -dot- bosch -dot- com>, 'TECHWR-L' <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Fri, 8 Nov 2013 16:37:07 +0000
I don't think I have ever used real footnotes, the kind I grew up with, in any documentation I have writen. They are distracting enough in print.
-----Original Message-----
From: Bruce Megan (ST-CO/MKP3) [mailto:Megan -dot- Bruce -at- us -dot- bosch -dot- com]
Sent: Friday, November 08, 2013 11:36 AM
To: Cardimon, Craig; 'TECHWR-L'
Subject: RE: Footnotes - acceptable in technical documentation?
I mean....it makes sense.....I guess, I just wanted to start a bit of a discussion.
-----Original Message-----
From: Cardimon, Craig [mailto:ccardimon -at- M-S-G -dot- com]
Sent: Friday, November 08, 2013 10:34 AM
To: Bruce Megan (ST-CO/MKP3); 'TECHWR-L'
Subject: RE: Footnotes - acceptable in technical documentation?
If I need to footnote an item, I put it right where I need it, in parentheses.
-----Original Message-----
From: techwr-l-bounces+ccardimon=m-s-g -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+ccardimon=m-s-g -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Bruce Megan (ST-CO/MKP3)
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.
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 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.
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.
