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:Re: Acronym Question From:punit shrivastava <punitshrivastava -at- gmail -dot- com> To:"Chinell, David F (UTCFS)" <David -dot- Chinell -at- ge -dot- com> Date:Thu, 18 Mar 2010 11:13:51 +0530
What I have seen in my short career of 8 years with 4 different companies is
the popular method of using full in the heading. Defining comes later.
This appears user friendly too. In the heading, we are just letting the user
know what the chapter is all about. Why to confuse them by placing acronym,
or for that matter any extra word that can be avoided or explained later in
the content.
Cheers!!
Punit
On Thu, Mar 18, 2010 at 1:22 AM, Chinell, David F (UTCFS) <
David -dot- Chinell -at- ge -dot- com> wrote:
> Heather:
>
> I'm with Donald on this. It's not going to stumble anyone if it's
> spelled out in full in the heading, and the heading is not the place to
> define it.
>
> I don't assume the heading content in the body text. The headings don't
> register the same as the body text. So I repeat rather than use
> articles. Extending this line of reasoning, I wouldn't rely on the
> heading to define the acronym. So there's really no need for it there.
>
> Bear
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
> produce desktop, Web, or print deliverables. Just write (or import)
> and Doc-To-Help does the rest. Free trial: http://www.doctohelp.com
>
> Explore CAREER options and paths related to Technical Writing,
> learn to create SOFTWARE REQUIREMENTS documents, and
> get tips on FUNCTIONAL SPECIFICATION best practices. Free at:
>http://www.ModernAnalyst.com <http://www.modernanalyst.com/>
>
> ---
> You are currently subscribed to TECHWR-L as punitshrivastava -at- gmail -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit
>http://lists.techwr-l.com/mailman/options/techwr-l/punitshrivastava%40gmail.com
>
>
> To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwr-l.com/ for more resources and info.
>
> Please move off-topic discussions to the Chat list, at:
>http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat
>
>
--
Punit S.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
produce desktop, Web, or print deliverables. Just write (or import)
and Doc-To-Help does the rest. Free trial: http://www.doctohelp.com
Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at: http://www.ModernAnalyst.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-