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