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.
Subject:style guide - references From:Miki Magyar <MDM0857 -at- MCDATA -dot- COM> Date:Mon, 13 Jan 1997 12:42:12 -0700
Sharon Belville asked about "the best way to cite my sources. in a
research paper" within a commercial environment.
My experience - I've done some Technical Notes (a.k.a. app notes or
reference papers) for consulting clients who wanted to put in all the
references to add weight to their arguments. I used an annotated
bibliography, which satisfied their need for lots of citations, didn't clutter
up the paper for people just wanting the facts, and provided a good
reference bibliography for those wanting more info. In some cases I've
added a 'Recommended Reading' attachment for the same purpose.
I think that the academic format of using footnotes is not often used in
commercial documents. As always, ask who's going to be reading it and
why, then design accordingly. I suspect that in commercial docs,
someone looks at the notes (foot- or end-) either to see if the writer
knows what they're talking about, or to look for sources of more info.
Miki
mikim -at- mcdata -dot- com
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
