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:Milan Davidović <milan -dot- lists -at- gmail -dot- com> To:"Bruce Megan (ST-CO/MKP3)" <Megan -dot- Bruce -at- us -dot- bosch -dot- com> Date:Fri, 8 Nov 2013 13:26:44 -0500
What's sort of technical documentation is it, who's reading/using it.
and what are they accustomed to seeing?
Here's a research idea; sample some tech doc from a defined
"population" (genre, I suppose) and see what sorts of things it does
(and doesn't) include (e.g. footnotes).
--Milan DavidoviÄ
Sent from my Yost 10
On Fri, Nov 8, 2013 at 11: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.
>
> Your thoughts?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New! Doc-to-Help 2013 features the industry's first HTML5 editor for authoring.